pycityvisitorparking 0.2.0__tar.gz

pycityvisitorparking-0.2.0/.devcontainer/devcontainer.json

@@ -0,0 +1,22 @@
+{
+  "name": "pyCityVisitorParking",
+  "image": "mcr.microsoft.com/devcontainers/python:1-3.13",
+  "features": {
+    "ghcr.io/devcontainers/features/git:1": {},
+    "ghcr.io/devcontainers/features/github-cli:1": {}
+  },
+  "postCreateCommand": "python -m pip install -U pip && pip install -e '.[dev]' && pre-commit install",
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "ms-python.python",
+        "ms-python.vscode-pylance",
+        "charliermarsh.ruff",
+        "editorconfig.editorconfig",
+        "github.vscode-github-actions",
+        "openai.chatgpt"
+      ]
+    }
+  },
+  "remoteUser": "vscode"
+}

pycityvisitorparking-0.2.0/.github/workflows/ci.yml

@@ -0,0 +1,50 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches: ["main"]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+          cache: "pip"
+
+      - name: Install Hatch
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install hatch
+
+      - name: Lint (ruff)
+        run: |
+          hatch run lint:check
+          hatch run lint:format-check
+
+      - name: Type check (pyright)
+        run: |
+          hatch run typecheck:run
+
+      - name: Tests
+        run: |
+          hatch run test:run
+
+      - name: Build (sdist + wheel)
+        run: |
+          hatch build
+
+      - name: Verify dist metadata
+        run: |
+          python -m pip install --upgrade twine
+          python -m twine check dist/*

pycityvisitorparking-0.2.0/.github/workflows/release.yml

@@ -0,0 +1,37 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  id-token: write
+  contents: read
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+          cache: "pip"
+
+      - name: Install build tooling
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install hatch twine
+
+      - name: Build
+        run: |
+          hatch build
+          python -m twine check dist/*
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

pycityvisitorparking-0.2.0/.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__/

pycityvisitorparking-0.2.0/.vscode/extensions.json

@@ -0,0 +1,10 @@
+{
+  "recommendations": [
+    "ms-python.python",
+    "ms-python.vscode-pylance",
+    "charliermarsh.ruff",
+    "editorconfig.editorconfig",
+    "github.vscode-github-actions",
+    "openai.chatgpt"
+  ]
+}

pycityvisitorparking-0.2.0/.vscode/settings.json

@@ -0,0 +1,19 @@
+{
+  "python.testing.pytestEnabled": true,
+  "python.testing.pytestArgs": ["tests"],
+
+  "editor.formatOnSave": true,
+  "editor.defaultFormatter": "charliermarsh.ruff",
+
+  "editor.codeActionsOnSave": {
+    "source.fixAll.ruff": "explicit",
+    "source.organizeImports.ruff": "explicit"
+  },
+
+  "files.insertFinalNewline": true,
+  "files.trimTrailingWhitespace": true,
+
+  "python.analysis.typeCheckingMode": "basic",
+  "python.analysis.autoSearchPaths": true,
+  "python.analysis.extraPaths": ["src"]
+}

pycityvisitorparking-0.2.0/AGENTS.md

@@ -0,0 +1,133 @@
+# AGENT.md — Development Guide (pyCityVisitorParking)
+
+✅ **Build an async Home Assistant–friendly API library (Python 3.13)**
+- Build an async Python library that standardizes Dutch municipal “visitor parking” operations for Home Assistant.
+- Target Python 3.13 and set `requires-python = ">=3.13"`.
+
+✅ **Use English as the primary project language**
+- Write all documentation, comments, docstrings, commit messages, and changelogs in English.
+- Use Dutch only when quoting provider UI text or official municipality wording, and label it clearly.
+
+✅ **Maintain root documentation and changelog**
+- Maintain root `README.md`.
+- Maintain root `CHANGELOG.md`.
+- Keep an “Unreleased” section and move entries into a versioned section on release.
+- Update root `CHANGELOG.md` on every release.
+
+✅ **Require docstrings and clear comments**
+- Add docstrings for all public modules, classes, and methods.
+- Add clear inline comments for non-obvious logic (e.g., time/UTC conversion, normalization, fallback behavior).
+- Keep comments/docstrings free of credentials, tokens, or other PII.
+
+✅ **Enforce project rules without exceptions**
+- Use an async-only public API.
+- Use `aiohttp` for all HTTP communication.
+- ❌ Avoid third-party provider plugins.
+- ❌ Avoid entry points.
+- Keep providers inside `src/pycityvisitorparking/provider/<provider_id>/`.
+- Allow adding a provider by changing only `provider/<provider_id>/...`.
+- Discover providers without importing provider code.
+- Keep public models strict and ❌ avoid provider-specific fields.
+
+✅ **Use the required repository layout**
+- Use `src/` layout.
+- Keep core code in `src/pycityvisitorparking/`.
+- Keep provider code in `src/pycityvisitorparking/provider/<provider_id>/`.
+- Keep `manifest.schema.json` in `src/pycityvisitorparking/provider/`.
+- Keep root `README.md` and `CHANGELOG.md` at repository root.
+- Keep per-provider `README.md` and `CHANGELOG.md` inside each provider folder.
+
+✅ **Implement the public Client facade**
+- Expose `Client` in `client.py`.
+- Implement `list_providers()` by reading manifests without importing provider modules.
+- Implement `get_provider(provider_id, ...)` by importing only the selected provider on-demand.
+- Support injecting an `aiohttp.ClientSession`.
+- ❌ Avoid closing an injected session.
+- Create an internal session only when not injected.
+- Provide `async with Client(...)` and/or `await client.aclose()` for internal cleanup.
+* Take `base_url` and `api_uri` as config inputs and pass them into providers.
+* ❌ Avoid hardcoded endpoints; keep only relative paths/constants.
+
+✅ **Define and enforce the provider interface**
+- Define `BaseProvider` in `provider/base.py`.
+- Require providers to implement standardized async methods for login, permit, reservations, and favorites.
+- Implement core fallback behavior for `update_favorite` when native update is not supported.
+
+✅ **Standardize time, license plates, and zone_validity**
+- Return public timestamps as UTC ISO 8601 with `Z` and without microseconds.
+- Convert provider-local/offset timestamps to UTC internally.
+- Normalize license plates to uppercase `A–Z0–9` and remove spaces/special chars.
+- Raise `ValidationError` for invalid or empty plates after normalization.
+- Filter `zone_validity` to include only chargeable windows and filter out free windows.
+
+✅ **Keep public dataclasses strict**
+- Define public dataclasses only in `models.py`.
+- Expose only:
+  - `ProviderInfo`
+  - `Permit`
+  - `ZoneValidityBlock`
+  - `Reservation`
+  - `Favorite`
+- ❌ Avoid adding provider-specific metadata to public models.
+
+✅ **Enforce validation rules**
+- Require `start_time` and `end_time` for `start_reservation` and ❌ avoid defaults.
+- Enforce `end_time > start_time` and raise `ValidationError` when violated.
+- Treat IDs as opaque strings and ❌ avoid format assumptions.
+- Ensure timestamps are parseable as timezone-aware UTC datetimes.
+
+✅ **Use secure HTTP standards**
+- Enable TLS verification.
+- Enforce request timeouts.
+- Map HTTP and provider errors to custom exceptions.
+- ❌ Avoid leaking raw `aiohttp` exceptions into the public API.
+- Apply retries only to idempotent GET requests and keep defaults conservative or disabled.
+
+✅ **Implement controlled errors and safe logging**
+- Define exceptions in `exceptions.py`.
+- Provide at minimum: `AuthError`, `NetworkError`, `ValidationError`, `ProviderError`.
+- ❌ Avoid including credentials, tokens, or PII in logs or exception messages.
+- Mask license plates in logs when logging is necessary.
+
+✅ **Implement provider discovery via manifests without imports**
+- Require each provider to include `manifest.json` with `id`, `name`, and `favorite_update_possible`.
+- Read manifests using `importlib.resources` without importing provider modules.
+- Import provider modules only when selected by `get_provider()`.
+
+✅ **Validate manifests via schema and fail CI on errors**
+- Add `manifest.schema.json` in `src/pycityvisitorparking/provider/`.
+- Validate every provider `manifest.json` against the schema.
+- Add a test that validates all manifests and fail CI on schema errors.
+
+✅ **Test without live calls**
+- ❌ Avoid live municipal services in tests.
+- Use fixtures and mocked HTTP responses.
+- Add tests for normalization, UTC conversion, loader discovery, schema validation, and fallback behaviors.
+
+✅ **Use Hatch for development, build, and publishing**
+- Use Hatch as the single entrypoint for dev workflows.
+- Run lint and format using Hatch environments.
+- Run tests using Hatch environments.
+- Build artifacts using `hatch build`.
+- Validate artifacts using `python -m twine check dist/*`.
+
+✅ **Verify documentation and pinned versions and correct assumptions**
+- Check the current project documentation and the versions pinned in our lockfiles and CI.
+- Update any assumptions immediately when documentation, lockfiles, and CI disagree.
+- Align `requires-python`, Hatch environments, and CI matrices to the pinned versions.
+- Prefer the repository as the source of truth for supported versions and tooling.
+- Avoid “latest” installs in CI and keep dev tooling versions pinned.
+
+✅ **Publish releases to PyPI in a controlled way (Hatch)**
+- Bump versions using `hatch version <new>` or `hatch version <major|minor|patch>`.
+- Update root `CHANGELOG.md` and move “Unreleased” entries into the new version section.
+- Create a git tag `vX.Y.Z` and push it.
+- Publish from CI on tags using trusted publishing (OIDC) when possible.
+- ❌ Avoid manual local publishing when CI publish is available.
+- Verify release contents include manifests, schema, and provider docs in `sdist`.
+
+✅ **Apply release rules**
+- Use SemVer and keep root `CHANGELOG.md` updated.
+- Bump MINOR for provider additions.
+- Bump PATCH for bug fixes.
+- Tag releases and maintain a clear changelog history.

pycityvisitorparking-0.2.0/CHANGELOG.md

@@ -0,0 +1,14 @@
+# CHANGELOG
+
+## Unreleased
+
+## 0.2.0
+
+- Add async client facade, provider interface, and provider discovery without imports.
+- Add strict public models, normalization utilities, and validation helpers.
+- Add manifest schema, loader utilities, and schema validation test.
+- Add fallback behavior for favorite updates and zero-provider tests.
+- Add documentation updates and pre-commit config for Ruff.
+- Add base_url and api_uri support for provider requests using relative paths.
+- Add The Hague provider implementation.
+- Document DVS Portal municipality endpoints.

pycityvisitorparking-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 sir-Unknown
+
+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.

pycityvisitorparking-0.2.0/PKG-INFO

@@ -0,0 +1,115 @@
+Metadata-Version: 2.4
+Name: pycityvisitorparking
+Version: 0.2.0
+Summary: Async integration layer between Home Assistant and Dutch municipal visitor parking APIs.
+Project-URL: Homepage, https://github.com/sir-Unknown/pyCityVisitorParking
+Project-URL: Repository, https://github.com/sir-Unknown/pyCityVisitorParking
+Project-URL: Issues, https://github.com/sir-Unknown/pyCityVisitorParking/issues
+Author: pyCityVisitorParking contributors
+License: MIT
+License-File: LICENSE
+Keywords: aiohttp,async,home-assistant,municipality,parking
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Home Automation
+Requires-Python: >=3.13
+Requires-Dist: aiohttp>=3.9
+Provides-Extra: dev
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: hatch; extra == 'dev'
+Requires-Dist: jsonschema; extra == 'dev'
+Requires-Dist: pre-commit; extra == 'dev'
+Requires-Dist: pyright==1.1.407; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-asyncio; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: twine; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# pyCityVisitorParking
+
+Async integration layer between Home Assistant and Dutch municipal visitor parking APIs.
+
+## Status
+
+This package ships the core client, provider interface, and discovery tooling,
+plus the following providers:
+
+- DVS Portal
+- The Hague
+
+`list_providers()` reads provider manifests under `src/pycityvisitorparking/provider/`.
+
+Provider documentation:
+
+- DVS Portal: [src/pycityvisitorparking/provider/dvsportal/README.md](src/pycityvisitorparking/provider/dvsportal/README.md)
+- The Hague: [src/pycityvisitorparking/provider/the_hague/README.md](src/pycityvisitorparking/provider/the_hague/README.md)
+
+## Installation
+
+```bash
+pip install pycityvisitorparking
+```
+
+## Usage
+
+```python
+import asyncio
+
+from pycityvisitorparking import Client
+
+
+async def main() -> None:
+    async with Client() as client:
+        providers = await client.list_providers()
+        print(providers)
+
+
+asyncio.run(main())
+```
+
+## Provider framework
+
+Providers are discovered via `manifest.json` files without importing provider
+modules. To add a provider later, create:
+
+```
+src/pycityvisitorparking/provider/<provider_id>/
+  manifest.json
+  __init__.py
+  api.py
+  const.py
+  README.md
+  CHANGELOG.md
+```
+
+Only files under `src/pycityvisitorparking/provider/<provider_id>/` should change
+in a provider PR.
+
+## Normalization rules
+
+- All public timestamps must be UTC ISO 8601 with `Z` and no microseconds.
+- License plates are normalized to uppercase `A-Z0-9` without spaces/symbols.
+- `zone_validity` must include only chargeable windows.
+
+## Development
+
+Run checks with Hatch:
+
+```bash
+hatch run lint:check
+hatch run lint:format-check
+hatch run test:run
+```
+
+Build artifacts:
+
+```bash
+hatch build
+python -m twine check dist/*
+```