pyneosol 0.4.1__tar.gz

pyneosol-0.4.1/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,51 @@
+name: Rapport de bug
+description: Un comportement inattendu du pilote ou du dongle
+labels: [bug]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ⚠️ **Masquez vos clés KeeLoq et numéros de série réels** dans tout log ou sortie
+        collé ici. Quiconque les possède peut commander vos volets.
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: Ce qui se passe, et ce que vous attendiez.
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Reproduction
+      description: Les étapes, et le code minimal qui déclenche le problème.
+    validations:
+      required: true
+  - type: input
+    id: dongle
+    attributes:
+      label: Dongle
+      description: Référence, version matérielle et logicielle (sortie de `AT?`).
+      placeholder: MAI-DONGLE868-1A, HW 0, SW Rev10
+    validations:
+      required: true
+  - type: input
+    id: environment
+    attributes:
+      label: Environnement
+      placeholder: macOS 15.4, Python 3.13, pyneosol 0.2.0
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Logs
+      description: Le dialogue AT si vous l'avez. Rendu en bloc de code, pas de formatage requis.
+      render: text
+  - type: checkboxes
+    id: hygiene
+    attributes:
+      label: Vérification
+      options:
+        - label: J'ai masqué toutes les clés et tous les numéros de série réels.
+          required: true

pyneosol-0.4.1/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Faille de sécurité
+    url: https://github.com/bbayszczak/pyneosol/security/advisories/new
+    about: Signalement privé — n'ouvrez jamais d'issue publique pour une vulnérabilité.

pyneosol-0.4.1/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,28 @@
+name: Proposition
+description: Une évolution du pilote
+labels: [enhancement]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        `pyneosol` est un pilote bas niveau **sans état** : position estimée, calibration et
+        persistance appartiennent à la couche appelante. Voir [CONTRIBUTING.md](../blob/main/CONTRIBUTING.md).
+  - type: textarea
+    id: besoin
+    attributes:
+      label: Besoin
+      description: Le problème concret que cela résout, pas la solution envisagée.
+    validations:
+      required: true
+  - type: textarea
+    id: proposition
+    attributes:
+      label: Proposition
+      description: Ce que vous imaginez, et l'état de validation du protocole s'il est concerné.
+  - type: checkboxes
+    id: perimetre
+    attributes:
+      label: Périmètre
+      options:
+        - label: Cette proposition ne fait pas remonter d'état (position, calibration) dans le pilote.
+          required: true

pyneosol-0.4.1/.github/dependabot.yml

@@ -0,0 +1,12 @@
+# Les actions sont épinglées sur des SHA complets dans .github/workflows (protection contre
+# le redéplacement d'un tag). Dependabot est donc indispensable : sans lui, ces SHA figés ne
+# recevraient jamais les correctifs de sécurité amont.
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+    commit-message:
+      # Conventional Commits : `ci` n'entraîne pas de release (cf. release-please).
+      prefix: ci

pyneosol-0.4.1/.github/workflows/ci.yml

@@ -0,0 +1,44 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
+        with:
+          enable-cache: true
+      - name: ruff check
+        run: uv run ruff check --output-format=github .
+      - name: ruff format
+        run: uv run ruff format --check --diff .
+
+  test:
+    name: Test (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
+        with:
+          enable-cache: true
+          python-version: ${{ matrix.python-version }}
+      # The test suite runs against a fake dongle, so no hardware is required.
+      - name: pytest
+        run: uv run --python ${{ matrix.python-version }} pytest

pyneosol-0.4.1/.github/workflows/release.yml

@@ -0,0 +1,141 @@
+name: Release
+
+on:
+  push:
+    branches: [main]
+
+permissions:
+  contents: read
+
+concurrency:
+  group: release-${{ github.ref }}
+  cancel-in-progress: false
+
+jobs:
+  # Maintient une PR de release à partir des Conventional Commits : elle accumule le
+  # CHANGELOG et le bump de version, et déclenche tag + GitHub Release une fois fusionnée.
+  release-please:
+    name: Release PR
+    runs-on: ubuntu-latest
+    permissions:
+      # Le GITHUB_TOKEN ne porte plus aucune écriture : le token de l'App s'en charge.
+      contents: read
+    outputs:
+      release_created: ${{ steps.release.outputs.release_created }}
+      tag_name: ${{ steps.release.outputs.tag_name }}
+    steps:
+      # release-please s'authentifie en GitHub App plutôt qu'avec le GITHUB_TOKEN, pour deux
+      # raisons. Ce dernier se voit refuser la création de PR tant que le réglage « Allow
+      # GitHub Actions to create and approve pull requests » du dépôt est décoché ; et surtout
+      # ses écritures ne déclenchent aucun workflow, si bien que la PR de release n'obtiendrait
+      # jamais les checks que le ruleset de main exige et resterait infusionnable. Une App est
+      # une identité distincte : ses événements déclenchent la CI, et le token d'installation
+      # qu'on en dérive expire au bout d'une heure.
+      - name: Mint a GitHub App token
+        id: app-token
+        uses: actions/create-github-app-token@bcd2ba49218906704ab6c1aa796996da409d3eb1 # v3.2.0
+        with:
+          client-id: ${{ secrets.RELEASE_PLEASE_CLIENT_ID }}
+          private-key: ${{ secrets.RELEASE_PLEASE_PRIVATE_KEY }}
+
+      - uses: googleapis/release-please-action@45996ed1f6d02564a971a2fa1b5860e934307cf7 # v5.0.0
+        id: release
+        with:
+          token: ${{ steps.app-token.outputs.token }}
+          config-file: release-please-config.json
+          manifest-file: .release-please-manifest.json
+
+      # release-please bump la version dans pyproject.toml mais ignore uv.lock, qui porte lui
+      # aussi la version du paquet. Sans resynchronisation, le lockfile est périmé dès la
+      # release et le premier `uv run` venu le réécrit. On corrige sur la branche de la PR de
+      # release, avant sa fusion, pour que main ne reçoive jamais de lockfile désaligné.
+      # `uv lock` relit pyproject.toml : la règle survit à tout changement de schéma de version.
+      - name: Check out the release pull request branch
+        if: steps.release.outputs.pr
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          ref: ${{ fromJson(steps.release.outputs.pr).headBranchName }}
+
+      - name: Set up uv
+        if: steps.release.outputs.pr
+        uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
+
+      - name: Sync uv.lock with the bumped version
+        if: steps.release.outputs.pr
+        env:
+          GH_TOKEN: ${{ steps.app-token.outputs.token }}
+          # Le court-circuit n'est pas décoratif : les expressions d'un bloc `env:` de step
+          # sont évaluées avant son `if:`, à la différence de celles d'un `with:`. Sur les runs
+          # qui publient une release au lieu d'ouvrir une PR, `steps.release.outputs.pr` est
+          # vide ; sans garde, `fromJson` recevrait la chaîne vide et ferait échouer le step
+          # alors même qu'il doit être sauté.
+          BRANCH: ${{ steps.release.outputs.pr && fromJson(steps.release.outputs.pr).headBranchName || '' }}
+        run: |
+          uv lock
+          if git diff --quiet uv.lock; then
+            echo "uv.lock already in sync"
+            exit 0
+          fi
+          # Le commit passe par l'API et non par `git commit` : le ruleset de main exige des
+          # signatures vérifiées, or un commit fabriqué dans le runner n'est pas signé et
+          # bloquerait la fusion de la PR de release (« Commits must have verified
+          # signatures »). GitHub signe de lui-même les commits créés via son API, comme il
+          # le fait déjà pour ceux de release-please. `sha` est le blob du fichier tel qu'il
+          # est sur la branche : `uv lock` a modifié la copie de travail, pas HEAD.
+          gh api -X PUT "repos/${{ github.repository }}/contents/uv.lock" \
+            -f message="chore: sync uv.lock with the release version" \
+            -f branch="$BRANCH" \
+            -f sha="$(git rev-parse HEAD:uv.lock)" \
+            -f content="$(base64 -w0 uv.lock)"
+
+  # `uv build` exécute le backend hatchling et ses dépendances, soit du code tiers. Ce job
+  # est donc volontairement dépourvu de `id-token: write` : une dépendance de build
+  # compromise n'y trouve aucun jeton OIDC dont elle pourrait se servir pour publier.
+  # Les distributions sont aussi attachées à la GitHub Release, d'où elles restent
+  # installables hors index (`pip install <url du .whl>`).
+  build:
+    name: Build distributions
+    needs: release-please
+    if: needs.release-please.outputs.release_created == 'true'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
+        with:
+          enable-cache: true
+      - name: Build sdist and wheel
+        run: uv build
+      - name: Attach them to the release
+        env:
+          GH_TOKEN: ${{ github.token }}
+          TAG_NAME: ${{ needs.release-please.outputs.tag_name }}
+        run: gh release upload "$TAG_NAME" dist/*
+      - name: Hand the distributions over to the publishing job
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: dist
+          path: dist/
+          if-no-files-found: error
+
+  # Trusted Publishing : PyPI authentifie le workflow sur le jeton OIDC que GitHub lui
+  # délivre, il n'y a donc aucun token d'API à stocker en secret.
+  # Ce job détient ce jeton, il est donc réduit au strict minimum : pas de checkout, pas de
+  # dépendance, aucun code du dépôt — seulement les distributions déjà construites et
+  # l'action de publication. Rien de ce qui s'y exécute ne provient d'une PR.
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: dist
+          path: dist/
+      # L'action refuse de réécrire une version déjà présente sur PyPI : un rejeu du
+      # workflow échoue au lieu de corrompre.
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2

pyneosol-0.4.1/.gitignore

@@ -0,0 +1,218 @@
+# 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
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# 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/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

pyneosol-0.4.1/.release-please-manifest.json

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

pyneosol-0.4.1/CHANGELOG.md

@@ -0,0 +1,68 @@
+# Changelog
+
+## [0.4.1](https://github.com/bbayszczak/pyneosol/compare/v0.4.0...v0.4.1) (2026-09-20)
+
+
+### Bug Fixes
+
+* **ci:** guard the branch name against an absent release pull request ([#20](https://github.com/bbayszczak/pyneosol/issues/20)) ([42f7195](https://github.com/bbayszczak/pyneosol/commit/42f7195db34eb8c7d9e3a0b9b4f1bf533e026598))
+
+## [0.4.0](https://github.com/bbayszczak/pyneosol/compare/v0.3.0...v0.4.0) (2026-09-20)
+
+
+### Features
+
+* log the AT dialogue without leaking secrets ([#11](https://github.com/bbayszczak/pyneosol/issues/11)) ([d3ad93a](https://github.com/bbayszczak/pyneosol/commit/d3ad93a45dab04358907548ee191f0a09bab7246))
+
+
+### Bug Fixes
+
+* **ci:** create the uv.lock sync commit through the GitHub API ([#19](https://github.com/bbayszczak/pyneosol/issues/19)) ([b91eee0](https://github.com/bbayszczak/pyneosol/commit/b91eee0e8dc7b798fa2ab0bc7c0cc6e571439a07))
+* **dongle:** wrap a non-numeric transmit power in ProtocolError ([#12](https://github.com/bbayszczak/pyneosol/issues/12)) ([4e560cd](https://github.com/bbayszczak/pyneosol/commit/4e560cd32a2a0d54f7e1bb882913d516121d3871))
+
+
+### Documentation
+
+* **readme:** add photos of the validated dongle ([#15](https://github.com/bbayszczak/pyneosol/issues/15)) ([e405433](https://github.com/bbayszczak/pyneosol/commit/e4054337294fab6407f91b32e9b8706f64722636))
+
+## [0.3.0](https://github.com/bbayszczak/pyneosol/compare/v0.2.0...v0.3.0) (2026-09-18)
+
+
+### Features
+
+* add the dongle driver ([f04cddc](https://github.com/bbayszczak/pyneosol/commit/f04cddc815d5152e1e92584fdc0a3a643eba9f16))
+* update README ([2d2048e](https://github.com/bbayszczak/pyneosol/commit/2d2048e4e55e708816482b470eba46e43d4cf30e))
+
+
+### Documentation
+
+* add AT protocol specification for the Neosol 868 dongle ([d02aa2b](https://github.com/bbayszczak/pyneosol/commit/d02aa2b0a16c19c186464910927a5c6eac80f30c))
+* add project disclaimer and hardware identification ([0c750c9](https://github.com/bbayszczak/pyneosol/commit/0c750c93b185686716f5d07197cfa41ea7dbda77))
+* add USB identification and the two rejection forms ([c4c9a8b](https://github.com/bbayszczak/pyneosol/commit/c4c9a8b7c3eb879a1298fdeebbf2be043af06816))
+* confirm the favourite position action and how it is recorded ([4748b5f](https://github.com/bbayszczak/pyneosol/commit/4748b5fe97a12d94652b056434daac40fef2750b))
+* document installation, usage and development ([f3e8039](https://github.com/bbayszczak/pyneosol/commit/f3e8039bc5adad5eb631a8ff9640673a2aaa798c))
+* explain how to run the demonstration script ([7d122af](https://github.com/bbayszczak/pyneosol/commit/7d122af3c0d996c2964bc9ab3287444e7d128ed9))
+* frame the project as compatible with the hardware, not derived from it ([14e4444](https://github.com/bbayszczak/pyneosol/commit/14e444451046bad2235de4c6ac7664b996c7d66e))
+* record that the dongle has no usable radio reception ([499491a](https://github.com/bbayszczak/pyneosol/commit/499491a38093c48b44d150c84f32f2886cbbe937))
+* use the exact dongle reference and drop the untested one ([c989827](https://github.com/bbayszczak/pyneosol/commit/c98982794ae318158f3c388a073f00cc76d32022))
+
+## [0.2.0](https://github.com/bbayszczak/pyneosol/compare/v0.1.0...v0.2.0) (2026-09-18)
+
+
+### Features
+
+* add the dongle driver ([e41e284](https://github.com/bbayszczak/pyneosol/commit/e41e284fec4763a2b4252db31e51581023371395))
+* update README ([534c10f](https://github.com/bbayszczak/pyneosol/commit/534c10f7ffe93fa8806535decdc3603bf0ce225f))
+
+
+### Documentation
+
+* add AT protocol specification for the Neosol 868 dongle ([e8e2f36](https://github.com/bbayszczak/pyneosol/commit/e8e2f36c333166339f42695901d0df51e340bc13))
+* add project disclaimer and hardware identification ([720a5f6](https://github.com/bbayszczak/pyneosol/commit/720a5f61b0190f59e7662944e2c688dab253fb41))
+* add USB identification and the two rejection forms ([997bed3](https://github.com/bbayszczak/pyneosol/commit/997bed39ac82149fc144e32007edc323f8a2991d))
+* confirm the favourite position action and how it is recorded ([ae09232](https://github.com/bbayszczak/pyneosol/commit/ae09232829c8fcc37b81e70bf8fa2a3a7a772790))
+* document installation, usage and development ([569b1e0](https://github.com/bbayszczak/pyneosol/commit/569b1e02481880294482f0644704dd0ec5d7220e))
+* explain how to run the demonstration script ([44e8deb](https://github.com/bbayszczak/pyneosol/commit/44e8debd9e6433f45ec3574c0516adbbe3da9e4f))
+* frame the project as compatible with the hardware, not derived from it ([3f6cd9a](https://github.com/bbayszczak/pyneosol/commit/3f6cd9a1901d976536548137dc3c605670cff1af))
+* record that the dongle has no usable radio reception ([9aa1a1f](https://github.com/bbayszczak/pyneosol/commit/9aa1a1fcb9197a9f503ffc04addd859ad32e4967))
+* use the exact dongle reference and drop the untested one ([49c2b60](https://github.com/bbayszczak/pyneosol/commit/49c2b60521a9e53afc8e96638f0a4e3bbdebda0f))