feat: rename pypi package to adam-ascii

tutorintelligence · Apr 21, 2024 · 28eb3d1 · 28eb3d1
1 parent b63e05d
commit 28eb3d1
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,9 @@
-# adam-modbus
+# adam-ascii
 
-[![PyPI version](https://badge.fury.io/py/adam-modbus.svg)](https://badge.fury.io/py/adam-modbus)
+[![PyPI version](https://badge.fury.io/py/adam-ascii.svg)](https://badge.fury.io/py/adam-ascii)
 
-stateless asyncio python interface for Advantech 6317 and 6052 modules.
+stateless asyncio python interface for Advantech 6317 and 6052 modules using the UDP ascii interface.
+
+for TCP modbus communication, see [tcp-modbus-aio](https://github.com/tutorintelligence/tcp-modbus-aio): this is probably a better idea for most ADAM use cases, as TCP is both more reliable and supports more devices.
+
+(note: this project was previously misnamed as `adam-modbus`, but in fact has never communicated via the modbus. whaddayaknow.)
diff --git a/adam_modbus/__init__.py → adam_ascii/__init__.py b/adam_modbus/__init__.py → adam_ascii/__init__.py
diff --git a/adam_modbus/interface.py → adam_ascii/interface.py b/adam_modbus/interface.py → adam_ascii/interface.py
diff --git a/adam_modbus/py.typed → adam_ascii/py.typed b/adam_modbus/py.typed → adam_ascii/py.typed
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,5 +1,5 @@
 [tool.poetry]
-name = "adam-modbus"
+name = "adam-ascii"
 version = "0.3.1"
 description = "asyncio python interface for Advantech ADAM modules"
 authors = ["Josh Gruenstein <[email protected]>"]
@@ -24,6 +24,6 @@ build-backend = "poetry.core.masonry.api"
 style = "poetry_scripts:style"
 
 [tool.semantic_release]
-version_variables = ["adam_modbus/__init__.py:__version__"]
+version_variables = ["adam_ascii/__init__.py:__version__"]
 version_toml = ["pyproject.toml:tool.poetry.version"]
 build_command = "pip install poetry && poetry build"