From eb5b2c799fc3ed117be71eb4c3b455536674209b Mon Sep 17 00:00:00 2001
From: Benjamin Braatz <bb@bbraatz.eu>
Date: Wed, 23 Aug 2023 06:32:13 +0200
Subject: [PATCH] setup.py and plugin rename.

---
 .gitignore                                    | 2 ++
 README.md                                     | 8 +++++---
 controlpi_plugins/{example.py => readjson.py} | 0
 setup.py                                      | 7 ++++---
 4 files changed, 11 insertions(+), 6 deletions(-)
 create mode 100644 .gitignore
 rename controlpi_plugins/{example.py => readjson.py} (100%)

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..6ece8bc
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,2 @@
+/venv/
+/controlpi_readjson.egg-info/
diff --git a/README.md b/README.md
index a7026c1..c112267 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,12 @@
-# ControlPi Plugin for <PURPOSE>
+# ControlPi Plugin for Reading JSON from a Serial Device
 This distribution package contains a plugin for the
 [ControlPi system](https://docs.graph-it.com/graphit/controlpi), that
-<...>
+opens a serial device, reads lines from it, and just sends them to the
+ControlPi message bus if they can be interpreted as (arbitrary) JSON
+objects/messages.
 
 Documentation (in German) can be found at [doc/index.md](doc/index.md) in
 the source repository and at
-[https://docs.graph-it.com/graphit/controlpi-<NAME>/](https://docs.graph-it.com/graphit/controlpi-<NAME>/).
+[https://docs.graph-it.com/graphit/controlpi-readjson/](https://docs.graph-it.com/graphit/controlpi-readjson/).
 Code documentation (in English) including doctests is contained in the
 source files.
diff --git a/controlpi_plugins/example.py b/controlpi_plugins/readjson.py
similarity index 100%
rename from controlpi_plugins/example.py
rename to controlpi_plugins/readjson.py
diff --git a/setup.py b/setup.py
index 13dd6d5..51e3f5d 100644
--- a/setup.py
+++ b/setup.py
@@ -4,16 +4,17 @@ with open("README.md", "r") as readme_file:
     long_description = readme_file.read()
 
 setuptools.setup(
-    name="controlpi-<NAME>",
+    name="controlpi-readjson",
     version="0.1.0",
     author="Graph-IT GmbH",
     author_email="info@graph-it.com",
-    description="ControlPi Plugin for <PURPOSE>",
+    description="ControlPi Plugin for Reading JSON from a Serial Device",
     long_description=long_description,
     long_description_content_type="text/markdown",
-    url="http://docs.graph-it.com/graphit/controlpi-<NAME>",
+    url="http://docs.graph-it.com/graphit/controlpi-readjson",
     packages=["controlpi_plugins"],
     install_requires=[
+        "pyserial-asyncio",
         "controlpi @ git+git://git.graph-it.com/graphit/controlpi.git",
     ],
     classifiers=[
-- 
2.34.1