Skip to main content

Python Synology API Wrapper

Project description

synology-api Pepy Total Downloads Website

GitHub last commit GitHub License

Synology Wrapper

If you find yourself here, most probably you are trying to develop something for your NAS, this wrapper might come to your help to build your script.

I would like to specify that I do this for hobby as is my passion and in my little free time.

Said this, there is no warranties chained and this library is provided "As Is", you will find many things can be simplified, and I slowly will but feel free to Contribute.

Premise

I've tried this wrapper only with python3.
I do not know if it actually runs with previous versions

Before opening an issue make sure you do your own research, if you are not sure, write me.

Installation

The package is distributed via pip3, but it can also be installed from source.

pip3 install synology-api

or

pip3 install git+https://github.com/N4S4/synology-api

Basic Usage

Here is a basic example on how to use the package, check Getting Started - Basic Usage for more details.

from synology_api.filestation import FileStation
from synology_api.downloadstation import DownloadStation

fs = FileStation(
    'Synology Ip',
    'Synology Port',
    'Username',
    'Password',
    secure=False,
    cert_verify=False,
    dsm_version=7,
    debug=True,
    otp_code=None
)

ds = DownloadStation(
    'Synology Ip',
    'Synology Port',
    'Username',
    'Password',
    secure=False,
    cert_verify=False,
    dsm_version=7,
    debug=True,
    otp_code=None
)

fs_info = fs.get_info()
ds_info = ds.get_info()

Available Functions

At the moment there are around +300 APIs implemented with countless methods for each, the majority is not documented, but some are.

You can find a exhaustive list here:
APIs - Supported APIs

Feeling kind?

If this code helps and you wish to support me:

Community

See Related projects

If you want to show your project in this section, write me.

Bugs

Maybe?

I hate bugs..

Well report them please (if you'll ever use this code)

Conclusions

There is still a lot to implement.

The code is probably in some parts twisted, I will try to optimize it at best.

Contributing

Just Don't Be Scared.
Check Contribute - Contribution 101 for useful information.

Author

  • Renato Visaggio - Initial Work - N4S4

Contributors

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

synology_api-0.8.1.tar.gz (123.2 kB view details)

Uploaded Source

Built Distribution

synology_api-0.8.1-py3-none-any.whl (131.5 kB view details)

Uploaded Python 3

File details

Details for the file synology_api-0.8.1.tar.gz.

File metadata

  • Download URL: synology_api-0.8.1.tar.gz
  • Upload date:
  • Size: 123.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.1

File hashes

Hashes for synology_api-0.8.1.tar.gz
Algorithm Hash digest
SHA256 3c026fbd54c22b3e6288ab056d5d474c06784f92c44901d90d0525ef57ac7423
MD5 1ee8858a76c30918324b02bd4258b784
BLAKE2b-256 543d85fac9fb1f48f07a274446f0f4517944520effd09d18fd6633ccd8d5d164

See more details on using hashes here.

File details

Details for the file synology_api-0.8.1-py3-none-any.whl.

File metadata

  • Download URL: synology_api-0.8.1-py3-none-any.whl
  • Upload date:
  • Size: 131.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.1

File hashes

Hashes for synology_api-0.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 885e9fdf17cfa3c97f4c4c27cf210b4a41478e87b8cb19cd15351d8173578272
MD5 7167a0750b9cfbe42b354fa385aa2937
BLAKE2b-256 b908f8b17fe4c1db71cddd9ee0828c73fd2f3602054dc81bbee327122e243a55

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page