Provide code from repository as real Python package

[amotl]

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 ¹.

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 ².

Installing the program, even without publishing the package to PyPI, is now a matter of invoking a single command ³.

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

Footnotes

1. https://github.com/cicerops/fritznagios ↩

2. The patch builds upon Use "easysnmp" and "snmpwalk" for huge efficiency gains #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. ↩

3. 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. ↩

[wernerfred]

Should we use something more randomized as IP address?

[amotl]

Sure we can do that. Do you have any suggestions?

[amotl]

Do you suggest it would be better to use an IP address from another private IP range, like 10.123.456.789 or 172.16.1.2? Shall we improve the inline documentation to signal to the user that she would have to put in the right value here?

Does it actually have to be an IP address? If not, I would prefer to use host names anyway. When doing so within documentation and configuration snippets, I usually use the example.org domain, which is exactly made for this purpose. So, what about synology.example.org, if that would make sense?

The benefit is that this would croak on the resolver level already, hopefully implictly telling the uninitiated user that she would have to adjust the corresponding setting.

[amotl]

I've just added 885f845 to implement my suggestion. #24 will assist the user to figure things out easily when just copy/pasting configuration snippets verbatim, even without reading the documentation.

[wernerfred]

If not, I would prefer to use host names anyway. When doing so within documentation and configuration snippets, I usually use the example.org domain, which is exactly made for this purpose. So, what about synology.example.org, if that would make sense?

Exactly my thoughts

[wernerfred]

@all-contributors add @amotl for ideas and example

[allcontributors]

@wernerfred

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