Rename module from 'smartmeter' to 'vienna_smartmeter' (#12)

* Rename smartmeter package to vienna_smartmeter * Remove package includes * Update README * Update smartmeter paths
platysma · Aug 26, 2021 · 58d5909 · 58d5909
1 parent ec84492
commit 58d5909
Show file tree

Hide file tree

Showing 10 changed files with 16 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -21,12 +21,16 @@ Install with pip:
 
 `pip install vienna-smartmeter`
 
+An async package is provided and can be installed with the 'async' extra:
+
+`pip install vienna-smartmeter[async]`
+
 ## How To Use
 
 Import the Smartmeter client, provide login information and access available api functions:
 
 ```python
-from smartmeter import Smartmeter
+from vienna_smartmeter import Smartmeter
 
 username = 'YOUR_LOGIN_USER_NAME'
 password = 'YOUR_PASSWORD'
@@ -35,6 +39,13 @@ api = Smartmeter(username, password)
 print(api.profil())
 ```
 
+The asnyc package can be imported by replacing Smartmeter with AsyncSmartmeter.
+
+```python
+from vienna_smartmeter import AsyncSmartmeter
+
+```
+
 ## Contributing
 
 Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

diff --git a/noxfile.py b/noxfile.py
@@ -16,7 +16,7 @@
     raise SystemExit(dedent(message))
 
 
-package = "smartmeter"
+package = "vienna_smartmeter"
 python_versions = ["3.9", "3.8", "3.7", "3.6"]
 nox.needs_version = ">= 2021.6.6"
 nox.options.sessions = (

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,8 +1,5 @@
 [tool.poetry]
 name = "vienna-smartmeter"
-packages = [
-    { include = "smartmeter", from = "src" },
-]
 version = "0.2.0"
 description = "Python library to access the Wiener Netze Smart Meter private API."
 authors = ["Platysma <[email protected]>"]
@@ -57,7 +54,7 @@ source = ["src", "*/site-packages"]
 
 [tool.coverage.run]
 branch = true
-source = ["smartmeter"]
+source = ["vienna_smartmeter"]
 
 [tool.coverage.report]
 show_missing = true

diff --git a/src/smartmeter/__init__.py → src/vienna_smartmeter/__init__.py b/src/smartmeter/__init__.py → src/vienna_smartmeter/__init__.py
diff --git a/src/smartmeter/_async/__init__.py → src/vienna_smartmeter/_async/__init__.py b/src/smartmeter/_async/__init__.py → src/vienna_smartmeter/_async/__init__.py
diff --git a/src/smartmeter/_async/client.py → src/vienna_smartmeter/_async/client.py b/src/smartmeter/_async/client.py → src/vienna_smartmeter/_async/client.py
diff --git a/src/smartmeter/client.py → src/vienna_smartmeter/client.py b/src/smartmeter/client.py → src/vienna_smartmeter/client.py
diff --git a/src/smartmeter/errors.py → src/vienna_smartmeter/errors.py b/src/smartmeter/errors.py → src/vienna_smartmeter/errors.py
diff --git a/tests/test_async_client.py b/tests/test_async_client.py
@@ -3,7 +3,7 @@
 from tests.const import DEMO_PASSWORD
 from tests.const import DEMO_USERNAME
 
-from smartmeter._async.client import AsyncSmartmeter
+from vienna_smartmeter._async.client import AsyncSmartmeter
 
 
 @pytest.fixture()

diff --git a/tests/test_client.py b/tests/test_client.py
@@ -5,7 +5,7 @@
 from tests.const import DEMO_PASSWORD
 from tests.const import DEMO_USERNAME
 
-from smartmeter.client import Smartmeter
+from vienna_smartmeter.client import Smartmeter
 
 
 @pytest.fixture()