diff --git a/README.md b/README.md index 07e374efd15f82652d48af2a5a2407d35d1d2ee1..4ca9615ecc0ef17974339286b1f3e0b13cfb5ab4 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,17 @@ when it senses lights are off in the room. It's written in Python 3 and requires a photoresistor-capacitor circuit connected to a Raspberry Pi running Snapcast. -# Setup +# Setup/Usage +* `sudo pip install DarkMute` +* `darkmute.py` + +To run this as a service, create a systemd service definition. Instructions pending. + +# Developer Setup + +* Clone this from [gitlab](https://git.xhost.io/jess/Dark-Mute) * Create and activate Python 3 virtual env * `pip install -e .` to install dependencies * Build the circuit, connected to GPIO Pin 7 -* add user to gpio group [/dev/gpiomem] (https://raspberrypi.stackexchange.com/a/40106) +* add user to gpio group [/dev/gpiomem](https://raspberrypi.stackexchange.com/a/40106) diff --git a/setup.py b/setup.py index 1e6cdf0909ddff24835b0928c5f7cb5037df7033..356567885163b03a6dc95f32f6182752c1e9554a 100644 --- a/setup.py +++ b/setup.py @@ -1,12 +1,27 @@ from setuptools import setup, find_packages +with open("README.md", "r") as fh: + long_description = fh.read() setup( name="DarkMute", version="0.1", + author="Jessica Ward", + description="Mute snapcast client playing on raspi3", + long_description=long_description, + long_description_content_type="text/markdown", + url="https://git.xhost.io/jess/Dark-Mute", packages=find_packages(), + scripts=['darkmute.py'], install_requires=[ "RPi.GPIO==0.6.3", "snapcast==2.0.8" + ], + classifiers=[ + "License :: OSI Approved :: MIT License", + "Intended Audience :: System Administrators", + "Intended Audience :: Developers", + "Programming Language :: Python :: 3", + "Topic :: System :: Hardware" ] )