===========================
Python API for Synology DSM
===========================

.. image:: https://travis-ci.org/ProtoThis/python-synology.svg?branch=master
    :target: https://travis-ci.org/ProtoThis/python-synology

.. image:: https://img.shields.io/pypi/v/python-synology.svg
    :alt: Library version
    :target: https://pypi.org/project/python-synology

.. image:: https://img.shields.io/pypi/pyversions/python-synology.svg
    :alt: Supported versions
    :target: https://pypi.org/project/python-synology

.. image:: https://pepy.tech/badge/python-synology
    :alt: Downloads
    :target: https://pypi.org/project/python-synology

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :alt: Formated with Black
    :target: https://github.com/psf/black

Installation
============

.. code-block:: bash

    [sudo] pip install python-synology


Usage
=====
Constructor::

        SynologyDSM(dsm_ip, dsm_port, username, password,
                    use_https=False, debugmode=False, dsm_version=6)

``dsm_version = 5 will use old DSM API to gather volumes and disks informations (from DSM 5.x versions)``

Module
------

You can import the module as `synology_dsm`.

.. code-block:: python

    from synology_dsm import SynologyDSM

    print("Creating Valid API")
    api = SynologyDSM("<SynologyIp>", "<SynologyPort>", "<Username>", "<Password>")

    print("=== Utilisation ===")
    print("CPU Load:   " + str(api.utilisation.cpu_total_load) + " %")
    print("Memory Use: " + str(api.utilisation.memory_real_usage) + " %")
    print("Net Up:     " + str(api.utilisation.network_up()))
    print("Net Down:   " + str(api.utilisation.network_down()))
    
    print("=== Storage ===")
    volumes = api.storage.volumes
    for volume in volumes:
        print("ID:         " + str(volume))
        print("Status:     " + str(api.storage.volume_status(volume)))
        print("% Used:     " + str(api.storage.volume_percentage_used(volume)) + " %")

    disks = api.storage.disks
    for disk in disks:
        print("ID:         " + str(disk))
        print("Name:       " + str(api.storage.disk_name(disk)))
        print("S-Status:   " + str(api.storage.disk_smart_status(disk)))
        print("Status:     " + str(api.storage.disk_status(disk)))
        print("Temp:       " + str(api.storage.disk_temp(disk)))
      
Credits / Special Thanks
========================
- https://github.com/florianeinfalt
- https://github.com/tchellomello
- https://github.com/Quentame
- https://github.com/aaska