pygira 0.0.1__tar.gz

pygira-0.0.1/.github/dependabot.yml

@@ -0,0 +1,20 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+    groups:
+      actions:
+        patterns:
+          - "*"
+
+  - package-ecosystem: uv
+    directory: /
+    schedule:
+      interval: weekly
+    groups:
+      python-minor-patch:
+        update-types:
+          - minor
+          - patch

pygira-0.0.1/.github/workflows/ci.yml

@@ -0,0 +1,60 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  quality:
+    name: Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --locked --group dev
+
+      - name: Ruff lint
+        run: uv run ruff check src/ tests/
+
+      - name: Ruff format check
+        run: uv run ruff format --check src/ tests/
+
+      - name: Mypy type check
+        run: uv run mypy src/
+
+      - name: Tests with coverage
+        run: uv run pytest
+
+      - name: Build distributions
+        run: uv build
+
+      - name: Report diff coverage on pull requests
+        if: github.event_name == 'pull_request'
+        run: uv run diff-cover coverage.xml --compare-branch origin/${{ github.base_ref }} --fail-under=0
+
+      - name: Report diff coverage on pushes
+        if: github.event_name == 'push' && github.event.before != '0000000000000000000000000000000000000000'
+        run: uv run diff-cover coverage.xml --compare-branch ${{ github.event.before }} --fail-under=0

pygira-0.0.1/.github/workflows/publish.yml

@@ -0,0 +1,30 @@
+name: Publish
+
+on:
+  push:
+    tags: ["v*"]
+
+permissions:
+  contents: read
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Build distributions
+        run: uv build
+
+      - name: Publish to PyPI
+        run: uv publish --trusted-publishing always

pygira-0.0.1/.gitignore

@@ -0,0 +1,33 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+
+
+# Device credentials — never commit
+devices.toml
+
+# Logs and other temporary files
+.tmp/
+
+# Tool caches and OS files
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+.DS_Store
+
+# Coverage reports
+.coverage
+coverage.xml
+htmlcov/
+
+# Local-only
+firmware/
+research/
+.omo/

pygira-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,32 @@
+repos:
+  - repo: local
+    hooks:
+      - id: ruff-check
+        name: ruff check
+        entry: uv run ruff check src/ tests/
+        language: system
+        pass_filenames: false
+
+      - id: ruff-format-check
+        name: ruff format --check
+        entry: uv run ruff format --check src/ tests/
+        language: system
+        pass_filenames: false
+
+      - id: mypy
+        name: mypy
+        entry: uv run mypy src/
+        language: system
+        pass_filenames: false
+
+      - id: pytest-coverage
+        name: pytest with coverage
+        entry: uv run pytest
+        language: system
+        pass_filenames: false
+
+      - id: diff-coverage
+        name: diff coverage against HEAD
+        entry: uv run diff-cover coverage.xml --compare-branch HEAD --fail-under=0
+        language: system
+        pass_filenames: false

pygira-0.0.1/.python-version

@@ -0,0 +1 @@
+3.14

pygira-0.0.1/CONTRIBUTING.md

@@ -0,0 +1,57 @@
+# Contributing
+
+## Development setup
+
+This project uses `uv` for dependency management and command execution. Supported Python versions are 3.10 through 3.14, and CI runs the full quality gate on each supported version.
+
+```bash
+uv sync --group dev
+uv run pre-commit install
+```
+
+Device credentials live in `devices.toml`, which is intentionally ignored by Git. Use `uv run pygira config init`, `uv run pygira config add-device ...`, and `uv run pygira config validate` to manage local device entries. `devices.toml.example` shows the direct-device and optional-location TOML shape.
+
+## Required checks
+
+Every commit should be clean for linting, formatting, type checking, tests, and diff coverage.
+The local pre-commit hooks run the same gates that CI runs:
+
+```bash
+uv run ruff check src/ tests/
+uv run ruff format --check src/ tests/
+uv run mypy src/
+uv run pytest
+uv run diff-cover coverage.xml --compare-branch HEAD --fail-under=0
+```
+
+`pytest` writes `coverage.xml`; run it before `diff-cover` if you invoke the commands manually.
+Overall coverage must stay at or above the configured floor. Diff coverage reports measure
+how well new or changed executable lines are covered; raise the `--fail-under` value when
+you are ready to make changed-line coverage a hard ratchet.
+
+## Adding a command
+
+All commands follow the same pattern: decorate with `@common_options`, call
+`resolve_login()` first, construct `ApiClient` with `profile.api_prefix`, and
+wrap the body in `try/except Exception as e: die(e)`. Commands are registered
+via `register(main)` in each file under `src/pygira/commands/` and wired in
+`cli.py`.
+
+`resolve_login()` pulls credentials from `devices.toml` when `--apartment` is
+given, or prompts interactively. G1-only features must call
+`require_capability()` before using the GDS transport.
+
+## Test infrastructure
+
+Tests use the custom HTTP mock in `tests/_httpmock.py` (not respx/responses —
+those only intercept httpx; this project uses a stdlib-based `_http.py` shim).
+Use the `@mock` decorator or `with mock:` context, then register routes with
+`respx.get(url)`, `respx.post(url)`, etc. Shared fixture data lives in
+`tests/fixtures.py`.
+
+## Pull requests
+
+- Keep pull requests focused and small enough to review.
+- Add or update tests for changed behavior.
+- Do not commit credentials, firmware dumps, local device IPs, or generated cache files.
+- Wait for the GitHub Actions CI workflow to pass before merging.