py-obdii 0.0.1a2__tar.gz

py_obdii-0.0.1a2/.github/README.md

@@ -0,0 +1,70 @@
+# OBDII
+
+A Python ≥3.8 library for interacting with OBDII.
+
+## Installing
+
+Python 3.8 or higher is required.
+
+A [Virtual Environment](https://docs.python.org/3/library/venv.html) is recommended to install the library.
+
+```bash
+# Linux/macOS
+python3 -m venv .venv
+source .venv/bin/activate
+
+# Windows
+py -3 -m venv .venv
+.venv\Scripts\activate
+```
+
+To install the development version, run:
+
+```bash
+# From Github
+pip install git+https://github.com/PaulMarisOUMary/OBDII@main[dev,test]
+
+# From local source
+git clone https://github.com/PaulMarisOUMary/OBDII
+cd OBDII
+pip install .[dev,test]
+```
+
+## Usage Example
+
+> [!IMPORTANT]
+> This library is still in the design phase and may change in the future.
+
+```python
+from obdii import commands
+from obdii.connection import Connection
+
+conn = Connection("COM5")
+
+conn.connect()
+response = conn.query(commands.VEHICLE_SPEED)
+print(f"Vehicle Speed: {response} km/h")
+
+conn.close()
+```
+
+## Contributing & Development
+
+The development of this library follows the [ELM327 PDF](/docs/ELM327.PDF) provided by Elm Electronics, with the goal of implementing most features and commands as outlined, starting from page 6 of the document.
+
+This library aims to deliver robust error handling, comprehensive logging, complete type hinting support, and follow best practices to create a reliable tool.
+
+Please, feel free to contribute and share your feedback !
+
+## Support & Contact
+
+For questions or support, open an issue or start a discussion on GitHub.
+Your feedback and questions are greatly appreciated and will help improve this project !
+
+- [Open an Issue](https://github.com/PaulMarisOUMary/OBDII/issues)
+- [Join the Discussion](https://github.com/PaulMarisOUMary/OBDII/discussions)
+
+---
+
+Thank you for using or contributing to this project.
+Follow our updates by leaving a star to this repository !

py_obdii-0.0.1a2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-present PaulMarisOUMary
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

py_obdii-0.0.1a2/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.2
+Name: py-obdii
+Version: 0.0.1a2
+Summary: A Python library for interacting with OBD-II.
+Author: PaulMarisOUMary
+License: MIT License
+        
+        Copyright (c) 2025-present PaulMarisOUMary
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+Project-URL: Repository, https://github.com/PaulMarisOUMary/OBDII
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyserial<4,>=3.5
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Provides-Extra: dev
+Requires-Dist: ELM327-emulator; extra == "dev"
+
+# OBDII
+
+A Python ≥3.8 library for interacting with OBDII.
+
+## Installing
+
+Python 3.8 or higher is required.
+
+A [Virtual Environment](https://docs.python.org/3/library/venv.html) is recommended to install the library.
+
+```bash
+# Linux/macOS
+python3 -m venv .venv
+source .venv/bin/activate
+
+# Windows
+py -3 -m venv .venv
+.venv\Scripts\activate
+```
+
+To install the development version, run:
+
+```bash
+# From Github
+pip install git+https://github.com/PaulMarisOUMary/OBDII@main[dev,test]
+
+# From local source
+git clone https://github.com/PaulMarisOUMary/OBDII
+cd OBDII
+pip install .[dev,test]
+```
+
+## Usage Example
+
+> [!IMPORTANT]
+> This library is still in the design phase and may change in the future.
+
+```python
+from obdii import commands
+from obdii.connection import Connection
+
+conn = Connection("COM5")
+
+conn.connect()
+response = conn.query(commands.VEHICLE_SPEED)
+print(f"Vehicle Speed: {response} km/h")
+
+conn.close()
+```
+
+## Contributing & Development
+
+The development of this library follows the [ELM327 PDF](/docs/ELM327.PDF) provided by Elm Electronics, with the goal of implementing most features and commands as outlined, starting from page 6 of the document.
+
+This library aims to deliver robust error handling, comprehensive logging, complete type hinting support, and follow best practices to create a reliable tool.
+
+Please, feel free to contribute and share your feedback !
+
+## Support & Contact
+
+For questions or support, open an issue or start a discussion on GitHub.
+Your feedback and questions are greatly appreciated and will help improve this project !
+
+- [Open an Issue](https://github.com/PaulMarisOUMary/OBDII/issues)
+- [Join the Discussion](https://github.com/PaulMarisOUMary/OBDII/discussions)
+
+---
+
+Thank you for using or contributing to this project.
+Follow our updates by leaving a star to this repository !

py_obdii-0.0.1a2/obdii/__init__.py

@@ -0,0 +1,5 @@
+__title__ = 'obdii'
+__author__ = 'PaulMarisOUMary'
+__license__ = 'MIT'
+__copyright__ = 'Copyright 2025-present PaulMarisOUMary'
+__version__ = '0.0.1a2'

py_obdii-0.0.1a2/py_obdii.egg-info/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.2
+Name: py-obdii
+Version: 0.0.1a2
+Summary: A Python library for interacting with OBD-II.
+Author: PaulMarisOUMary
+License: MIT License
+        
+        Copyright (c) 2025-present PaulMarisOUMary
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+Project-URL: Repository, https://github.com/PaulMarisOUMary/OBDII
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyserial<4,>=3.5
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Provides-Extra: dev
+Requires-Dist: ELM327-emulator; extra == "dev"
+
+# OBDII
+
+A Python ≥3.8 library for interacting with OBDII.
+
+## Installing
+
+Python 3.8 or higher is required.
+
+A [Virtual Environment](https://docs.python.org/3/library/venv.html) is recommended to install the library.
+
+```bash
+# Linux/macOS
+python3 -m venv .venv
+source .venv/bin/activate
+
+# Windows
+py -3 -m venv .venv
+.venv\Scripts\activate
+```
+
+To install the development version, run:
+
+```bash
+# From Github
+pip install git+https://github.com/PaulMarisOUMary/OBDII@main[dev,test]
+
+# From local source
+git clone https://github.com/PaulMarisOUMary/OBDII
+cd OBDII
+pip install .[dev,test]
+```
+
+## Usage Example
+
+> [!IMPORTANT]
+> This library is still in the design phase and may change in the future.
+
+```python
+from obdii import commands
+from obdii.connection import Connection
+
+conn = Connection("COM5")
+
+conn.connect()
+response = conn.query(commands.VEHICLE_SPEED)
+print(f"Vehicle Speed: {response} km/h")
+
+conn.close()
+```
+
+## Contributing & Development
+
+The development of this library follows the [ELM327 PDF](/docs/ELM327.PDF) provided by Elm Electronics, with the goal of implementing most features and commands as outlined, starting from page 6 of the document.
+
+This library aims to deliver robust error handling, comprehensive logging, complete type hinting support, and follow best practices to create a reliable tool.
+
+Please, feel free to contribute and share your feedback !
+
+## Support & Contact
+
+For questions or support, open an issue or start a discussion on GitHub.
+Your feedback and questions are greatly appreciated and will help improve this project !
+
+- [Open an Issue](https://github.com/PaulMarisOUMary/OBDII/issues)
+- [Join the Discussion](https://github.com/PaulMarisOUMary/OBDII/discussions)
+
+---
+
+Thank you for using or contributing to this project.
+Follow our updates by leaving a star to this repository !

py_obdii-0.0.1a2/py_obdii.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+pyproject.toml
+requirements.txt
+setup.py
+.github/README.md
+obdii/__init__.py
+py_obdii.egg-info/PKG-INFO
+py_obdii.egg-info/SOURCES.txt
+py_obdii.egg-info/dependency_links.txt
+py_obdii.egg-info/requires.txt
+py_obdii.egg-info/top_level.txt
+tests/test_helper.py

py_obdii-0.0.1a2/py_obdii.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

py_obdii-0.0.1a2/py_obdii.egg-info/requires.txt

@@ -0,0 +1,7 @@
+pyserial<4,>=3.5
+
+[dev]
+ELM327-emulator
+
+[test]
+pytest

py_obdii-0.0.1a2/py_obdii.egg-info/top_level.txt

@@ -0,0 +1 @@
+obdii

py_obdii-0.0.1a2/pyproject.toml

@@ -0,0 +1,29 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "py-obdii"
+description = "A Python library for interacting with OBD-II."
+readme = { file = ".github/README.md", content-type = "text/markdown" }
+authors = [{ name = "PaulMarisOUMary" }]
+license = { file = "LICENSE" }
+requires-python = ">=3.8"
+dynamic = ["version", "dependencies"]
+
+[project.urls]
+Repository = "https://github.com/PaulMarisOUMary/OBDII"
+
+[tool.setuptools]
+packages = ["obdii"]
+
+[tool.setuptools.dynamic]
+dependencies = { file = "requirements.txt" }
+
+[project.optional-dependencies]
+test = [
+    "pytest",
+]
+dev = [
+    "ELM327-emulator",
+]

py_obdii-0.0.1a2/requirements.txt

@@ -0,0 +1 @@
+pyserial>=3.5,<4

py_obdii-0.0.1a2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

py_obdii-0.0.1a2/setup.py

@@ -0,0 +1,32 @@
+from setuptools import setup
+import re
+
+
+def derive_version() -> str:
+    version = ''
+    with open('obdii/__init__.py') as f:
+        version = re.search(r'^__version__\s*=\s*[\'"]([^\'"]*)[\'"]', f.read(), re.MULTILINE).group(1)
+
+    if not version:
+        raise RuntimeError('version is not set')
+
+    if version.endswith(('a', 'b', 'rc')):
+        # append version identifier based on commit count
+        try:
+            import subprocess
+
+            p = subprocess.Popen(['git', 'rev-list', '--count', 'HEAD'], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+            out, _ = p.communicate()
+            if out:
+                version += out.decode('utf-8').strip()
+            p = subprocess.Popen(['git', 'rev-parse', '--short', 'HEAD'], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+            out, _ = p.communicate()
+            if out:
+                version += '+g' + out.decode('utf-8').strip()
+        except Exception:
+            pass
+
+    return version
+
+
+setup(version=derive_version())