Skip to content

Commit

Permalink
Update readme and setup.py
Browse files Browse the repository at this point in the history
  • Loading branch information
bb4L committed Mar 22, 2020
1 parent d18b46b commit f698db3
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 9 deletions.
28 changes: 23 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
## 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)
8 changes: 4 additions & 4 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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=[
Expand All @@ -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',
],
Expand Down

0 comments on commit f698db3

Please sign in to comment.