From f698db312da550d57088c8e050d8765bb00b53e1 Mon Sep 17 00:00:00 2001 From: bb4L <39266013+bb4L@users.noreply.github.com> Date: Sun, 22 Mar 2020 11:35:39 +0100 Subject: [PATCH] Update readme and setup.py --- README.md | 28 +++++++++++++++++++++++----- setup.py | 8 ++++---- 2 files changed, 27 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 3ec390f..d28278c 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,27 @@ # rpi-radio-alarm -package for the rpi-radio-alarm development +Package to simplify the communication to a instance of the [rpi-radio-alarm](https://github.com/bb4L/rpi-radio-alarm) -## Usage +# Usage `pip install rpi-radio-alarm` -### Return Values -The `ApiHelper` object takes a `ResponseParser` as optional argument. -This defines the way the different Responses are returned. \ No newline at end of file +## Objects +This package includes two classes. + +### ApiHelper +This class can handle commands and arguments and send them to the [rpi-radio-alarm](https://github.com/bb4L/rpi-radio-alarm) and return the response + +This is done in the `do_command(cmd, args)`, `cmd` has to be one of `constants.COMMANDS` and `args` is a dictionary with the appropiate values. + +### RpiArgumentParser +The `RpiArgumentParser` parses string input to correct arguments for the ApiHelper. + +### ResponseParser +This class defines for the `ApiHelper` how to parse the response from the [rpi-radio-alarm](https://github.com/bb4L/rpi-radio-alarm). + +# Example Usages +[rpi-radio-alarm-discordbot-python](https://github.com/bb4L/rpi-radio-alarm-discordbot-python) + +[rpi-radio-alarm-telegrambot](https://github.com/bb4L/rpi-radio-alarm-telegrambot/) + +# License +[LGPLv3](LICENSE) \ No newline at end of file diff --git a/setup.py b/setup.py index ca47252..7e69a6c 100644 --- a/setup.py +++ b/setup.py @@ -3,14 +3,14 @@ setup( name='rpi-radio-alarm', - version='0.3.4', - license='BSD-3', + version='0.3.5', + license='LGPLv3', description='rpi-radio-alarm library', long_description=open('README.md').read(), long_description_content_type='text/markdown', author='bb4L', author_email='39266013+bb4L@users.noreply.github.com', - url='https://github.com/bb4L/rpi-radio-alarm-pip', + project_urls={"Source Code": "https://github.com/bb4L/rpi-radio-alarm-pip"}, packages=['rpiradioalarm'], keywords=['Raspberry Pi', 'radio', 'alarm'], install_requires=[ @@ -30,7 +30,7 @@ 'Development Status :: 4 - Beta', 'Intended Audience :: Developers', 'Topic :: Software Development', - 'License :: OSI Approved :: MIT License', + "License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)", 'Programming Language :: Python :: 3', 'Programming Language :: Python :: 3.6', ],