clean

bpaulin · Apr 26, 2019 · f2fa91a · f2fa91a
1 parent f29c170
commit f2fa91a
Show file tree

Hide file tree

Showing 22 changed files with 28 additions and 588 deletions.
diff --git a/AUTHORS.rst b/AUTHORS.rst
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
diff --git a/HISTORY.rst → HISTORY.md b/HISTORY.rst → HISTORY.md
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,11 +1 @@
-include AUTHORS.rst
-include CONTRIBUTING.rst
-include HISTORY.rst
-include LICENSE
-include README.rst
-
-recursive-include tests *
-recursive-exclude * __pycache__
-recursive-exclude * *.py[co]
-
-recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif
+include HISTORY.md
diff --git a/Makefile b/Makefile
diff --git a/README.md b/README.md
@@ -0,0 +1,15 @@
+# brownpaperbag
+
+[![image](https://img.shields.io/pypi/v/brownpaperbag.svg)](https://pypi.python.org/pypi/brownpaperbag)
+
+[![image](https://img.shields.io/travis/bpaulin/brownpaperbag.svg)](https://travis-ci.org/bpaulin/brownpaperbag)
+
+[![Updates](https://pyup.io/repos/github/bpaulin/brownpaperbag/shield.svg)](https://pyup.io/repos/github/bpaulin/brownpaperbag/)
+
+But you try and tell the young people today that...
+
+  - Free software: MIT license
+
+## Features
+
+  - TODO
diff --git a/README.rst b/README.rst
diff --git a/brownpaperbag/bpbgate.py b/brownpaperbag/bpbgate.py
@@ -65,6 +65,7 @@ async def _readuntil(self, separator):
         return response
 
     async def readevent(self, separator="##"):
+        """Listen to gateway events."""
         data = await self._reader.readuntil(separator.encode())
         response = data.decode()
         self.logger.debug("received: " + response)
@@ -153,17 +154,17 @@ async def send_list(self, who):
             return hitems
 
     async def get_light_ids(self):
-        """return list of all lights ids"""
+        """Return list of all lights ids."""
         self.logger.info("polling lights")
         return await self.send_list("1")
 
     async def get_cover_ids(self):
-        """return list of all cover ids"""
+        """Return list of all cover ids."""
         self.logger.info("polling covers")
         return await self.send_list("2")
 
     async def get_energy_ids(self):
-        """return list of all cover ids"""
+        """Return list of all cover ids."""
         self.logger.info("polling covers")
         return await self.send_list("18")
 

diff --git a/brownpaperbag/cli.py b/brownpaperbag/cli.py
@@ -67,6 +67,7 @@ def raw(ctx, command):
 @click.argument("id")
 @click.pass_context
 def light(ctx, operation, id):
+    """Interact with a light."""
     gate = ctx.obj["GATE"]
     loop = asyncio.get_event_loop()
     try:

diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/authors.rst b/docs/authors.rst