Add Synology API metadata file#10
Open
N4S4 wants to merge 1 commit into
Open
Conversation
Create software/synology-api.yml containing metadata for the Synology API Python wrapper (DSM 7.x support). Includes website and source URLs, description, MIT license, Python platform, and tags.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Create software/synology-api.yml containing metadata for the Synology API Python wrapper (DSM 7.x support). Includes website and source URLs, description, MIT license, Python platform, and tags.
Thanks for taking the time to suggest an addition to awesome-sysadmin!
To ensure your Pull Request is dealt with swiftly, please check the following (check the boxes
[x]):Demolinks should only be used for interactive demos, i.e. not video demonstrations. If login credentials are required to access the demo, please link to the credentials directly.my-awesome-software.yml.platformshould match the platforms required to install and run the software.Please take some time to answer the following questions as best you can:
Pythonic wrapper covering the complete Synology NAS API. Provides a consistent, documented interface to dozens of DSM services (FileStation, DownloadStation, SurveillanceStation, and more), making NAS automation accessible without wrestling with raw API calls.
Yes, daily for over 5 years as i am the owner as well. Using on a DS218+ for automating backups, file management, download queues, surveillance events, and system monitoring.
Personal home lab setup. The API coverage is broad enough to scale to small business use.
One NAS (DS218+), 5 user accounts, multiple shared folders. The library also powers companion projects: a Telegram bot for NAS control, a Home Assistant integration, and a collection of automation recipes.
Pros: comprehensive DSM 6.x and 7.x API coverage, Python-native, well-documented with auto-generated API reference docs, MIT licensed.
Cons: some newer DSM APIs not yet covered (library is growing), requires programming knowledge (not a GUI tool).
The library is actively maintained with regular releases (latest v0.9.0, May 2026). It has a growing ecosystem: synology-api-recipes, a Telegram bot, and a Home Assistant custom integration. The auto-generated documentation on GitHub Pages is thorough.