manualbeagle 0.1.0__tar.gz

manualbeagle-0.1.0/.dockerignore

@@ -0,0 +1,9 @@
+# Only pyproject.toml, README.md, LICENSE, NOTICE and src/ go into the image.
+*
+!pyproject.toml
+!README.md
+!LICENSE
+!NOTICE
+!src/
+**/__pycache__
+**/*.py[cod]

manualbeagle-0.1.0/.editorconfig

@@ -0,0 +1,26 @@
+# https://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 4
+
+[*.py]
+max_line_length = 110
+
+[*.{yml,yaml,toml,json,html,css,js}]
+indent_size = 2
+
+[*.md]
+indent_size = 2
+# a trailing double space is a line break in Markdown
+trim_trailing_whitespace = false
+
+[tests/fixtures/**]
+# recorded responses are written by the test harness; leave them as they are
+trim_trailing_whitespace = false
+insert_final_newline = unset

manualbeagle-0.1.0/.gitattributes

@@ -0,0 +1,3 @@
+* text=auto eol=lf
+*.pdf binary
+*.png binary

manualbeagle-0.1.0/.github/CODEOWNERS

@@ -0,0 +1,2 @@
+# Everything is reviewed by the maintainer.
+* @sstangle73

manualbeagle-0.1.0/.github/FUNDING.yml

@@ -0,0 +1,2 @@
+# The Sponsor button on GitHub. Supporting the project is optional: everything works without it.
+buy_me_a_coffee: stevenstorie

manualbeagle-0.1.0/.github/ISSUE_TEMPLATE/broken_adapter.yml

@@ -0,0 +1,38 @@
+name: Broken adapter
+description: A brand that used to work finds the wrong manual or nothing at all.
+title: "Broken adapter: "
+labels: ["adapter: broken"]
+body:
+  - type: input
+    id: adapter
+    attributes:
+      label: Adapter id
+      description: From `manualbeagle adapters list` (the first column).
+      placeholder: lg
+    validations:
+      required: true
+  - type: input
+    id: model
+    attributes:
+      label: Model
+      placeholder: WM5700HVA
+    validations:
+      required: true
+  - type: textarea
+    id: output
+    attributes:
+      label: Output
+      description: The output of `manualbeagle find <brand> <model> --why` and, if you have a clone, `manualbeagle adapters test <id> --live -v`.
+      render: text
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: What you expected
+      description: The right manual's link, if you found it in a browser.
+  - type: input
+    id: version
+    attributes:
+      label: Version or commit
+      description: "`manualbeagle --version`, or `git rev-parse --short HEAD`."

manualbeagle-0.1.0/.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,43 @@
+name: Bug
+description: Something other than a brand adapter doesn't work as documented.
+title: "Bug: "
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        For a security problem, don't open an issue: see [SECURITY.md](https://github.com/manualbeagle/manualbeagle/blob/main/SECURITY.md).
+        Please remove API keys, private addresses and anything else private from what you paste.
+  - type: textarea
+    id: what
+    attributes:
+      label: What happened
+      description: The command you ran and its full output.
+      render: text
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: What you expected
+    validations:
+      required: true
+  - type: textarea
+    id: steps
+    attributes:
+      label: How to reproduce it
+      description: Steps, and the relevant part of your config.toml (without secrets).
+  - type: input
+    id: version
+    attributes:
+      label: Version or commit
+      description: "`manualbeagle --version`, or `git rev-parse --short HEAD`."
+    validations:
+      required: true
+  - type: input
+    id: environment
+    attributes:
+      label: Operating system and Python version
+      placeholder: "Ubuntu 24.04, Python 3.12"
+    validations:
+      required: true

manualbeagle-0.1.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Security problem
+    url: https://github.com/manualbeagle/manualbeagle/security/policy
+    about: Report it privately, as SECURITY.md describes, not in a public issue.

manualbeagle-0.1.0/.github/ISSUE_TEMPLATE/feature.yml

@@ -0,0 +1,30 @@
+name: Feature
+description: Suggest something new, such as another inventory to file manuals in.
+title: "Feature: "
+labels: ["enhancement"]
+body:
+  - type: textarea
+    id: problem
+    attributes:
+      label: What you're trying to do
+      description: The problem, not only the solution.
+    validations:
+      required: true
+  - type: textarea
+    id: idea
+    attributes:
+      label: What would help
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: What you've tried instead
+  - type: checkboxes
+    id: rules
+    attributes:
+      label: Project rules
+      description: Manual Beagle keeps a few rules whatever the feature (see CONTRIBUTING.md).
+      options:
+        - label: It works without AI (AI may only add to a rules-only path).
+          required: true
+        - label: It doesn't host, share or mirror manuals, crawl a site in bulk, or get around bot protection or logins.
+          required: true

manualbeagle-0.1.0/.github/ISSUE_TEMPLATE/new_brand.yml

@@ -0,0 +1,48 @@
+name: New brand
+description: Ask for (or offer to write) an adapter for a brand Manual Beagle doesn't know yet.
+title: "Brand: "
+labels: ["brand"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks! Check [docs/brands.md](https://github.com/manualbeagle/manualbeagle/blob/main/docs/brands.md) first: the brand may already be there under
+        another name. Writing the adapter yourself is usually about 15 minutes; [CONTRIBUTING.md](https://github.com/manualbeagle/manualbeagle/blob/main/CONTRIBUTING.md) walks through it.
+  - type: input
+    id: brand
+    attributes:
+      label: Brand
+      description: As it's written on the rating plate, and any other names it goes by.
+      placeholder: "AlorAir (also AlorAir Solutions)"
+    validations:
+      required: true
+  - type: input
+    id: site
+    attributes:
+      label: The maker's support or manuals page
+      description: Where a person finds manuals on the maker's own site.
+      placeholder: "https://www.example.com/support"
+    validations:
+      required: true
+  - type: textarea
+    id: models
+    attributes:
+      label: Example models
+      description: Two or more real model numbers, ideally ones you own, so the adapter has test cases.
+      placeholder: |
+        Galaxy 60
+        Sentinel HD55
+    validations:
+      required: true
+  - type: textarea
+    id: how
+    attributes:
+      label: How the site lists documents (if you know)
+      description: PDF links in the page's HTML, JSON embedded in the page, or an API the page calls. The browser's developer tools (Network tab) show it.
+  - type: checkboxes
+    id: rules
+    attributes:
+      label: Fetching rules
+      options:
+        - label: As far as I can tell, the site's terms don't forbid automated access, and it doesn't need a login or pass a CAPTCHA to reach the manuals (if it does, say so above; it can still get a link-only adapter).
+        - label: I'd like to write this adapter myself.

manualbeagle-0.1.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,37 @@
+## What this changes
+
+<!-- One or two sentences. For an adapter: the brand, how it searches, and how many models pass live. -->
+
+## Checklist
+
+- [ ] `ruff check src tests` and `ruff format --check src tests` pass.
+- [ ] `pytest` passes (offline; no test touches the network unless it's marked `live`).
+- [ ] Docs are updated for anything a user or contributor would notice (`README.md`, `CONTRIBUTING.md`,
+      `docs/architecture.md`, `docs/adapters.md`, `docs/integrations/`), and public code has docstrings and type
+      hints.
+- [ ] Colour in any output is paired with a glyph or a word.
+- [ ] No new dependency, or it's compatible with Apache-2.0 and the description says why it's needed.
+
+### For a new or changed adapter
+
+- [ ] The adapter starts with its header: the site, how it searches, known gaps, and today's date as
+      "Last verified".
+- [ ] At least two real test cases, with fixtures recorded by `manualbeagle adapters test <id> --record -v`.
+- [ ] The fixtures are small and hold no PDF bodies.
+- [ ] `docs/brands.md` regenerated with `manualbeagle adapters scoreboard --write docs/brands.md`.
+- [ ] The output of `manualbeagle adapters test <id> --live -v` is below.
+
+### Fetching rules
+
+- [ ] Every request goes through `ctx.http` (the polite client): one request at a time per site, the project's
+      User-Agent.
+- [ ] Nothing crawls or lists a site in bulk: only what one lookup needs.
+- [ ] Nothing gets around a CAPTCHA, a bot wall or a login (no browser automation, spoofed headers, copied
+      cookies or proxies).
+- [ ] The site's terms don't forbid automated access.
+- [ ] Nothing hosts, shares or mirrors PDFs.
+
+## Live test output (adapters)
+
+```
+```

manualbeagle-0.1.0/.github/dependabot.yml

@@ -0,0 +1,14 @@
+version: 2
+updates:
+  - package-ecosystem: pip
+    directory: /
+    schedule:
+      interval: weekly
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+  - package-ecosystem: docker # the Dockerfile's base image
+    directory: /
+    schedule:
+      interval: weekly

manualbeagle-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,34 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+    paths-ignore: ["docs/**", "*.md"]
+  pull_request:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    strategy:
+      fail-fast: false
+      matrix:
+        # Every version pyproject.toml's classifiers name.
+        python-version: ["3.12", "3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+      - run: pip install -e ".[dev]"
+      - run: ruff check src tests
+      - run: ruff format --check src tests
+      - run: pytest -q

manualbeagle-0.1.0/.github/workflows/live-adapters.yml

@@ -0,0 +1,138 @@
+name: Live adapters
+
+# Runs every adapter's test cases against the real sites, which is how we notice when a maker's site changes.
+#
+# - Every night once the repository is public. While it's private, Actions minutes count, so the schedule runs
+#   on Mondays only (the second cron line); each job's `if` picks the line that applies.
+# - The run's page shows the live scoreboard (docs/brands.md with a Live column) and a report of what broke; the
+#   JSON results, the log and both Markdown files are kept as the run's artifact for 30 days.
+# - A scheduled run keeps one issue labelled `live-adapters` current: opened when something breaks, its text
+#   replaced and a comment added each night it stays broken, closed when every case passes again. A manual run
+#   touches the issue only when asked to (the `report` input).
+# - Requests follow the project's fetching rules like any lookup: one at a time per site, with a delay, and
+#   nothing that crawls. A site that blocks the runner shows as ✗ blocked; nothing tries to get around it.
+
+on:
+  schedule:
+    - cron: "17 7 * * *" # nightly, public repository
+    - cron: "17 9 * * 1" # Mondays, private repository
+  workflow_dispatch:
+    inputs:
+      adapters:
+        description: "adapter ids, space-separated (blank: all)"
+        required: false
+      report:
+        description: "open, update or close the live-adapters issue"
+        type: boolean
+        default: false
+
+permissions:
+  contents: read
+
+concurrency:
+  group: live-adapters
+  cancel-in-progress: false
+
+jobs:
+  live:
+    if: >-
+      github.event_name != 'schedule'
+      || (github.event.schedule == '17 7 * * *' && !github.event.repository.private)
+      || (github.event.schedule == '17 9 * * 1' && github.event.repository.private)
+    runs-on: ubuntu-latest
+    timeout-minutes: 45
+    outputs:
+      broken: ${{ steps.report.outputs.broken }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: pip
+      - run: pip install -e .
+      - name: Run live adapter tests
+        # The input goes through an environment variable, never into the script itself, so a value can't inject
+        # shell commands. It's split on spaces on purpose: one argument per adapter id.
+        env:
+          ADAPTERS: ${{ github.event.inputs.adapters }}
+        run: |
+          # shellcheck disable=SC2086 # split on purpose
+          manualbeagle adapters test --live --json live.json $ADAPTERS | tee live.txt
+        continue-on-error: true
+      - name: Live scoreboard
+        run: manualbeagle adapters scoreboard --live live.json --write live-brands.md
+      - name: What broke
+        id: report
+        env:
+          RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
+        run: |
+          set +e
+          manualbeagle adapters report live.json --run-url "$RUN_URL" --write report.md
+          python -c "import json; r = json.load(open('live.json', encoding='utf-8')); print('broken=' + str(sum(x['status'] in ('fail', 'error', 'blocked') for x in r)))" >> "$GITHUB_OUTPUT"
+          exit 0
+      - name: Summary
+        run: |
+          {
+            cat report.md
+            echo
+            echo '## Live scoreboard'
+            sed -n '/^| Brand /,$p' live-brands.md
+          } >> "$GITHUB_STEP_SUMMARY"
+      - uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: live-adapters
+          path: |
+            live.json
+            live.txt
+            live-brands.md
+            report.md
+          retention-days: 30
+          if-no-files-found: warn
+      - name: Fail the run when a case broke
+        env:
+          BROKEN: ${{ steps.report.outputs.broken }}
+        run: |
+          if [ "${BROKEN:-1}" != "0" ]; then echo "✗ $BROKEN broken case(s): see the summary"; exit 1; fi
+          echo "✓ every case that ran passed"
+
+  issue:
+    name: Keep the live-adapters issue current
+    needs: live
+    if: >-
+      always() && needs.live.outputs.broken != ''
+      && (github.event_name == 'schedule' || inputs.report == true)
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    permissions:
+      contents: read
+      issues: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: live-adapters
+      - name: Open, update or close the issue
+        env:
+          GH_TOKEN: ${{ github.token }}
+          GH_REPO: ${{ github.repository }}
+          BROKEN: ${{ needs.live.outputs.broken }}
+          RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
+        run: |
+          label=live-adapters
+          gh label create "$label" --color FBCA04 \
+            --description "An adapter's test cases fail against the maker's live site" --force
+          num=$(gh issue list --label "$label" --state open --json number --jq '.[0].number // empty')
+          today=$(date -u +%F)
+          if [ "$BROKEN" != "0" ]; then
+            if [ -n "$num" ]; then
+              gh issue edit "$num" --title "Live adapters: $BROKEN case(s) broken" --body-file report.md
+              gh issue comment "$num" --body "✗ $today: $BROKEN case(s) broken ([run]($RUN_URL)). The description has the current list."
+            else
+              gh issue create --title "Live adapters: $BROKEN case(s) broken" --label "$label" --body-file report.md
+            fi
+          elif [ -n "$num" ]; then
+            gh issue comment "$num" --body "✓ $today: every case that ran passed ([run]($RUN_URL)). Closing."
+            gh issue close "$num"
+          else
+            echo "✓ nothing broken and no open issue"
+          fi

manualbeagle-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,193 @@
+name: Release
+
+# Pushing a version tag (v0.1.0) builds the sdist, the wheel and the container image, checks them, and publishes
+# them only when the repository variable RELEASE_ENABLED is "true" (Settings > Secrets and variables > Actions >
+# Variables). Until then, and on every manual run, it builds and checks everything and publishes nothing. The
+# steps to switch it on, and to make a release, are in docs/releasing.md.
+#
+# - PyPI: trusted publishing (OpenID Connect), so there is no API token to store. It needs a publisher on PyPI
+#   for this repository, this workflow file and the environment "pypi", whose required reviewer approves each
+#   upload.
+# - Container: ghcr.io/<owner>/<repo>, for linux/amd64 and linux/arm64, tagged with the version; a final version
+#   (not a pre-release such as 0.2.0rc1) is also tagged <major>.<minor> and "latest".
+# - GitHub release: made last, from the tag, with the version's CHANGELOG.md section as its notes and the sdist
+#   and wheel attached.
+# - Third-party actions are pinned to commit SHAs (the version in a comment), since these jobs can publish;
+#   Dependabot keeps them current.
+
+on:
+  push:
+    tags: ["v[0-9]*"]
+  workflow_dispatch: # a dry run: builds and checks, publishes nothing
+
+permissions:
+  contents: read
+
+concurrency:
+  group: release-${{ github.ref }}
+  cancel-in-progress: false
+
+jobs:
+  build:
+    name: Build and check the packages
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    outputs:
+      version: ${{ steps.version.outputs.version }}
+      prerelease: ${{ steps.version.outputs.prerelease }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install build twine
+      - run: python -m build
+      - run: twine check --strict dist/*
+      - name: The version, and whether it's a pre-release
+        id: version
+        run: |
+          version=$(python -c "import glob; print(glob.glob('dist/*.whl')[0].split('-')[1])")
+          echo "version=$version" >> "$GITHUB_OUTPUT"
+          if echo "$version" | grep -qE '^[0-9]+\.[0-9]+\.[0-9]+$'; then pre=false; else pre=true; fi
+          echo "prerelease=$pre" >> "$GITHUB_OUTPUT"
+          echo "version $version, pre-release: $pre"
+      - name: The tag matches the package's version
+        if: github.ref_type == 'tag'
+        env:
+          TAG: ${{ github.ref_name }}
+          VERSION: ${{ steps.version.outputs.version }}
+        run: |
+          if [ "v$VERSION" != "$TAG" ]; then
+            echo "✗ tag $TAG doesn't match version $VERSION (src/manualbeagle/__init__.py)"; exit 1
+          fi
+          echo "✓ tag $TAG matches version $VERSION"
+      - name: CHANGELOG.md has a section for the version
+        if: github.ref_type == 'tag'
+        env:
+          VERSION: ${{ steps.version.outputs.version }}
+        run: |
+          grep -q "^## \[$VERSION\]" CHANGELOG.md || { echo "✗ no '## [$VERSION]' in CHANGELOG.md"; exit 1; }
+          echo "✓ CHANGELOG.md has [$VERSION]"
+      - name: The wheel and the sdist each install and run
+        run: |
+          for pkg in dist/*.whl dist/*.tar.gz; do
+            rm -rf /tmp/check && python -m venv /tmp/check
+            /tmp/check/bin/pip install --quiet "$pkg"
+            /tmp/check/bin/manualbeagle --version
+            /tmp/check/bin/manualbeagle adapters list > /dev/null
+            echo "✓ $pkg"
+          done
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+          if-no-files-found: error
+
+  docker:
+    name: Build, check and (when enabled) publish the image
+    needs: build
+    runs-on: ubuntu-latest
+    timeout-minutes: 45
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - uses: actions/checkout@v4
+      - name: Build for this runner
+        env:
+          VERSION: ${{ needs.build.outputs.version }}
+        run: docker build --build-arg "VERSION=$VERSION" -t manualbeagle:check .
+      - name: The image starts and answers
+        run: |
+          docker run -d --name mb -p 127.0.0.1:8765:8765 -e MANUALBEAGLE_WEB_TOKEN=check manualbeagle:check
+          for _ in $(seq 1 30); do curl -fs http://127.0.0.1:8765/healthz && break; sleep 1; done
+          curl -fs http://127.0.0.1:8765/healthz
+          docker exec mb manualbeagle --version
+          docker exec mb python -c "from manualbeagle.library import ocr_available; assert ocr_available(), 'no OCR'"
+          test "$(docker exec mb id -u)" = 1000
+          echo "✓ the image serves /healthz, has OCR and runs as uid 1000"
+          docker image ls manualbeagle:check
+      - name: Container log
+        if: always()
+        run: docker logs mb || true
+      - uses: docker/setup-qemu-action@c7c53464625b32c7a7e944ae62b3e17d2b600130 # v3.7.0
+        if: github.ref_type == 'tag' && vars.RELEASE_ENABLED == 'true'
+      - uses: docker/setup-buildx-action@8d2750c68a42422c14e847fe6c8ac0403b4cbd6f # v3.12.0
+        if: github.ref_type == 'tag' && vars.RELEASE_ENABLED == 'true'
+      - uses: docker/login-action@c94ce9fb468520275223c153574b00df6fe4bcc9 # v3.7.0
+        if: github.ref_type == 'tag' && vars.RELEASE_ENABLED == 'true'
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Image tags
+        id: tags
+        if: github.ref_type == 'tag' && vars.RELEASE_ENABLED == 'true'
+        env:
+          REPO_IMAGE: ghcr.io/${{ github.repository }}
+          VERSION: ${{ needs.build.outputs.version }}
+          PRE: ${{ needs.build.outputs.prerelease }}
+        run: |
+          image=$(echo "$REPO_IMAGE" | tr '[:upper:]' '[:lower:]')
+          tags="$image:$VERSION"
+          if [ "$PRE" = false ]; then tags="$tags,$image:${VERSION%.*},$image:latest"; fi
+          echo "tags=$tags" >> "$GITHUB_OUTPUT"
+          echo "$tags"
+      - uses: docker/build-push-action@10e90e3645eae34f1e60eeb005ba3a3d33f178e8 # v6.19.2
+        if: github.ref_type == 'tag' && vars.RELEASE_ENABLED == 'true'
+        with:
+          context: .
+          platforms: linux/amd64,linux/arm64
+          push: true
+          build-args: VERSION=${{ needs.build.outputs.version }}
+          tags: ${{ steps.tags.outputs.tags }}
+
+  pypi:
+    name: Publish to PyPI
+    needs: [build, docker]
+    if: github.ref_type == 'tag' && vars.RELEASE_ENABLED == 'true'
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    environment:
+      name: pypi
+      url: https://pypi.org/project/manualbeagle/
+    permissions:
+      id-token: write # trusted publishing
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@7245906fb61fa33a13554f9d5fb856fe61758086 # v1.14.3
+
+  github-release:
+    name: The GitHub release
+    needs: [build, pypi]
+    if: github.ref_type == 'tag' && vars.RELEASE_ENABLED == 'true'
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - name: Notes from CHANGELOG.md, then the release
+        env:
+          GH_TOKEN: ${{ github.token }}
+          TAG: ${{ github.ref_name }}
+          VERSION: ${{ needs.build.outputs.version }}
+          PRE: ${{ needs.build.outputs.prerelease }}
+        run: |
+          awk -v v="$VERSION" '
+            index($0, "## [" v "]") == 1 { on = 1; next }
+            on && /^## \[/ { exit }
+            on && /^\[[^]]+\]: / { exit }
+            on { print }
+          ' CHANGELOG.md > notes.md
+          test -s notes.md || { echo "✗ CHANGELOG.md has no notes for $VERSION"; exit 1; }
+          flags=""
+          if [ "$PRE" = true ]; then flags="--prerelease"; fi
+          gh release create "$TAG" dist/* --verify-tag --title "$VERSION" --notes-file notes.md $flags

manualbeagle-0.1.0/.gitignore

@@ -0,0 +1,21 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+.venv/
+venv/
+build/
+dist/
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.coverage
+htmlcov/
+# local library, downloads and secrets
+/library/
+/cache/
+*.sqlite
+*.sqlite-journal
+.env
+
+# Claude Code: personal notes for this checkout
+CLAUDE.local.md

manualbeagle-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+# Runs the same ruff checks as CI on every commit: pip install pre-commit, then pre-commit install.
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.17.3
+    hooks:
+      - id: ruff-check
+      - id: ruff-format

manualbeagle-0.1.0/AGENTS.md

@@ -0,0 +1,6 @@
+# AGENTS.md
+
+Instructions for AI coding agents working on this repository are in [CLAUDE.md](CLAUDE.md): the layout, how to
+run the tests and lint, how to add a brand adapter, and the project's rules (fetching politely and never around
+bot protection, no AI required, Apache-2.0-compatible dependencies, colour always paired with a glyph or word,
+and documentation as part of every change). Contributors should also read [CONTRIBUTING.md](CONTRIBUTING.md).