wernerfred / check_synology

This plugin will check a lot of different values on your Synology DiskStation.
MIT License
17 stars 25 forks source link

Provide code from repository as real Python package #20

Closed amotl closed 2 years ago

amotl commented 2 years ago

Dear Frederic,

in order to improve installation convenience, we decided to add some bits to bring the repository into a shape similar to another Python-based monitoring plugin we recently worked on ^1.

Along the lines of adding a corresponding setup.py file, the patch also improves the README file and splits off the Icinga configuration files into a separate folder for easier consumption and extensibility [^patch].

Installing the program, even without publishing the package to PyPI, is now a matter of invoking a single command [^install].

pip install git+https://github.com/wernerfred/check_synology

By putting the corresponding Icinga configuration snippets into separate files, they can be easily acquired as well.

wget https://raw.githubusercontent.com/wernerfred/check_synology/master/icinga2/synology-command.conf
wget https://raw.githubusercontent.com/wernerfred/check_synology/master/icinga2/synology-services.conf
wget https://raw.githubusercontent.com/wernerfred/check_synology/master/icinga2/synology-host.conf

We hope you like those improvements.

With kind regards, Andreas.

/cc @tonkenfo

[^install]: This tremendously eases usability, because the interface from synology-command.conf will be more "stable" - no need to explicitly assign the Python interpreter there anymore, it will be automatically linked when expanding the console_scripts entrypoint defined in setup.py. [^patch]: The patch builds upon #19, so the diff relative to this would be https://github.com/cicerops/check_synology/compare/easysnmp...package. The new README file can be directly viewed at package/README.md.

wernerfred commented 2 years ago

@all-contributors add @amotl for ideas and example

allcontributors[bot] commented 2 years ago

@wernerfred

I've put up a pull request to add @amotl! :tada: