py-opendisplay 0.1.1__tar.gz

py_opendisplay-0.1.1/.github/workflows/lint.yml

@@ -0,0 +1,25 @@
+name: Lint
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Set up Python
+        run: uv python install 3.11
+
+      - name: Install dependencies
+        run: uv sync --extra dev
+
+      - name: Run ruff
+        run: uv run ruff check .

py_opendisplay-0.1.1/.github/workflows/release.yml

@@ -0,0 +1,58 @@
+name: Release Please
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  pull-requests: write
+  id-token: write  # For PyPI trusted publishing
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: googleapis/release-please-action@v4
+        id: release
+        with:
+          release-type: python
+          package-name: py-opendisplay
+          bump-minor-pre-major: true
+          bump-patch-for-minor-pre-major: true
+
+      # The following steps only run if a release was created
+      - name: Checkout code
+        if: ${{ steps.release.outputs.release_created }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        if: ${{ steps.release.outputs.release_created }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install uv
+        if: ${{ steps.release.outputs.release_created }}
+        uses: astral-sh/setup-uv@v4
+
+      - name: Install dependencies
+        if: ${{ steps.release.outputs.release_created }}
+        run: uv sync
+
+      # - name: Run tests
+      #   if: ${{ steps.release.outputs.release_created }}
+      #   run: uv run pytest tests/ -v
+
+      # - name: Run linter
+      #   if: ${{ steps.release.outputs.release_created }}
+      #   run: uv run ruff check .
+
+      - name: Build package
+        if: ${{ steps.release.outputs.release_created }}
+        run: uv build
+
+      - name: Publish to PyPI
+        if: ${{ steps.release.outputs.release_created }}
+        uses: pypa/gh-action-pypi-publish@release/v1

py_opendisplay-0.1.1/.github/workflows/test.yml

@@ -0,0 +1,40 @@
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    name: Test Suite (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --all-extras
+
+      - name: Run tests
+        run: uv run pytest tests/ -v --tb=short
+
+      - name: Generate coverage report
+        if: matrix.python-version == '3.11'
+        run: uv run pytest tests/ --cov=src/opendisplay --cov-report=xml --cov-report=term
+
+      - name: Upload coverage to Codecov
+        if: matrix.python-version == '3.11'
+        uses: codecov/codecov-action@v4
+        with:
+          file: ./coverage.xml
+          fail_ci_if_error: false

py_opendisplay-0.1.1/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

py_opendisplay-0.1.1/.release-please-config.json

@@ -0,0 +1,20 @@
+{
+  "packages": {
+    ".": {
+      "release-type": "python",
+      "package-name": "py-opendisplay",
+      "bump-minor-pre-major": true,
+      "bump-patch-for-minor-pre-major": true,
+      "changelog-sections": [
+        { "type": "feat", "section": "Features" },
+        { "type": "fix", "section": "Bug Fixes" },
+        { "type": "perf", "section": "Performance Improvements" },
+        { "type": "docs", "section": "Documentation" },
+        { "type": "refactor", "section": "Code Refactoring" },
+        { "type": "test", "section": "Tests" },
+        { "type": "build", "section": "Build System" },
+        { "type": "ci", "section": "Continuous Integration" }
+      ]
+    }
+  }
+}

py_opendisplay-0.1.1/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.1.1"
+}

py_opendisplay-0.1.1/CHANGELOG.md

@@ -0,0 +1,35 @@
+# Changelog
+
+## [0.1.1](https://github.com/OpenDisplay-org/py-opendisplay/compare/v0.1.0...v0.1.1) (2025-12-29)
+
+
+### Bug Fixes
+
+* add conftest ([673db99](https://github.com/OpenDisplay-org/py-opendisplay/commit/673db99bfa85608a2d5bcdea1a36d37b25e76b51))
+
+## 0.1.0 (2025-12-29)
+
+
+### Features
+
+* add discovery function ([2760ef9](https://github.com/OpenDisplay-org/py-opendisplay/commit/2760ef913440b8689bdc6c39d09050fc5f757b64))
+
+## 0.1.0 (2025-12-29)
+
+### Features
+
+* Initial release of py-opendisplay
+* BLE device discovery with `discover_devices()` function
+* Connect by device name or MAC address
+* Automatic image upload with compression support
+* Device interrogation and capability detection
+* Image resize warnings for automatic resizing
+* Support for multiple color schemes (BW, BWR, BWY, BWRY, BWGBRY, GRAYSCALE_4)
+* Firmware version reading
+* TLV config parsing for OpenDisplay protocol
+
+### Documentation
+
+* Quick start guide with examples
+* API documentation
+* Image resizing behavior documentation

py_opendisplay-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 OpenDisplay.org
+
+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_opendisplay-0.1.1/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.4
+Name: py-opendisplay
+Version: 0.1.1
+Summary: Python library for OpenDisplay BLE e-paper displays
+Project-URL: Homepage, https://opendisplay.org
+Project-URL: Repository, https://github.com/OpenDisplay-org/py-opendisplay
+Author-email: g4bri3lDev <admin@g4bri3l.de>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: ble,bluetooth,display,e-paper,eink,opendisplay
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Hardware
+Requires-Python: >=3.11
+Requires-Dist: bleak>=1.0.1
+Requires-Dist: numpy>=1.24.0
+Requires-Dist: pillow>=10.0.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.19.1; extra == 'dev'
+Requires-Dist: ruff>=0.14.10; extra == 'dev'
+Provides-Extra: property
+Requires-Dist: hypothesis>=6.148.8; extra == 'property'
+Provides-Extra: test
+Requires-Dist: pytest-asyncio>=1.3.0; extra == 'test'
+Requires-Dist: pytest-cov>=7.0.0; extra == 'test'
+Requires-Dist: pytest-xdist>=3.8.0; extra == 'test'
+Requires-Dist: pytest>=9.0.2; extra == 'test'
+Description-Content-Type: text/markdown
+
+# py-opendisplay
+
+Python library for communicating with OpenDisplay BLE e-paper displays.
+
+## Installation
+
+```bash
+pip install py-opendisplay
+```
+
+## Quick Start
+
+### Option 1: Using MAC Address
+
+```python
+from opendisplay import OpenDisplayDevice
+from PIL import Image
+
+async with OpenDisplayDevice(mac_address="AA:BB:CC:DD:EE:FF") as device:
+    image = Image.open("photo.jpg")
+    await device.upload_image(image)
+```
+
+### Option 2: Using Device Name (Auto-Discovery)
+
+```python
+from opendisplay import OpenDisplayDevice, discover_devices
+from PIL import Image
+
+# List available devices
+devices = await discover_devices()
+print(devices)  # {"OpenDisplay-A123": "AA:BB:CC:DD:EE:FF", ...}
+
+# Connect using name
+async with OpenDisplayDevice(device_name="OpenDisplay-A123") as device:
+  image = Image.open("photo.jpg")
+  await device.upload_image(image)
+```
+
+Image Resizing
+
+Images are automatically resized to match the display dimensions. A warning is logged if resizing occurs:
+
+`WARNING:opendisplay.device:Resizing image from 1920x1080 to 296x128` (device display size)
+
+For best results, resize images to the exact display dimensions before uploading.
+
+Development
+
+```bash
+uv sync --all-extras
+uv run pytest
+```

py_opendisplay-0.1.1/README.md

@@ -0,0 +1,53 @@
+# py-opendisplay
+
+Python library for communicating with OpenDisplay BLE e-paper displays.
+
+## Installation
+
+```bash
+pip install py-opendisplay
+```
+
+## Quick Start
+
+### Option 1: Using MAC Address
+
+```python
+from opendisplay import OpenDisplayDevice
+from PIL import Image
+
+async with OpenDisplayDevice(mac_address="AA:BB:CC:DD:EE:FF") as device:
+    image = Image.open("photo.jpg")
+    await device.upload_image(image)
+```
+
+### Option 2: Using Device Name (Auto-Discovery)
+
+```python
+from opendisplay import OpenDisplayDevice, discover_devices
+from PIL import Image
+
+# List available devices
+devices = await discover_devices()
+print(devices)  # {"OpenDisplay-A123": "AA:BB:CC:DD:EE:FF", ...}
+
+# Connect using name
+async with OpenDisplayDevice(device_name="OpenDisplay-A123") as device:
+  image = Image.open("photo.jpg")
+  await device.upload_image(image)
+```
+
+Image Resizing
+
+Images are automatically resized to match the display dimensions. A warning is logged if resizing occurs:
+
+`WARNING:opendisplay.device:Resizing image from 1920x1080 to 296x128` (device display size)
+
+For best results, resize images to the exact display dimensions before uploading.
+
+Development
+
+```bash
+uv sync --all-extras
+uv run pytest
+```

py_opendisplay-0.1.1/pyproject.toml

@@ -0,0 +1,76 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "py-opendisplay"
+version = "0.1.1"
+description = "Python library for OpenDisplay BLE e-paper displays"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.11"
+authors = [
+    {name = "g4bri3lDev", email = "admin@g4bri3l.de"}
+]
+
+keywords = ["opendisplay", "e-paper", "eink", "ble", "bluetooth", "display"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: System :: Hardware",
+]
+
+
+dependencies = [
+    "bleak>=1.0.1",
+    "pillow>=10.0.0",
+    "numpy>=1.24.0",
+]
+
+[project.optional-dependencies]
+test = [
+    "pytest>=9.0.2",
+    "pytest-asyncio>=1.3.0",
+    "pytest-cov>=7.0.0",
+    "pytest-xdist>=3.8.0"
+
+]
+
+property = [
+    "hypothesis>=6.148.8"
+]
+
+dev = [
+    "mypy>=1.19.1",
+    "ruff>=0.14.10"
+]
+
+[project.urls]
+Homepage = "https://opendisplay.org"
+Repository = "https://github.com/OpenDisplay-org/py-opendisplay"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/opendisplay"]
+
+[tool.ruff]
+line-length = 120
+target-version = "py311"
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I"]
+
+[tool.mypy]
+python_version = "3.11"
+strict = true
+warn_return_any = true
+warn_unused_configs = true
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]