pbs-client 0.1.0__tar.gz

pbs_client-0.1.0/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,66 @@
+name: "🐞 Bug Report"
+description: Report a reproducible bug.
+type: "Bug"
+body:
+  - type: checkboxes
+    attributes:
+      label: Pre-flight
+      options:
+        - label: I searched existing issues and this is not a duplicate.
+          required: true
+
+  - type: textarea
+    id: summary
+    attributes:
+      label: Summary
+      description: One or two sentences describing the bug.
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Reproduction
+      description: Steps and/or a minimal code example that reproduces the issue. Wrap code in triple backticks.
+      placeholder: |
+        1. Import X and call Y with Z
+        2. Observe error
+
+        ```python
+        # minimal example
+        ```
+    validations:
+      required: true
+
+  - type: textarea
+    id: actual
+    attributes:
+      label: Actual behaviour
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behaviour
+    validations:
+      required: true
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: Error output
+      description: Full traceback if applicable. Formatted automatically.
+      render: python-traceback
+
+  - type: textarea
+    id: system
+    attributes:
+      label: System info
+      description: |
+        Run this in your environment and paste the output:
+
+        ```shell
+        python <(curl -s https://raw.githubusercontent.com/AustralianCancerDataNetwork/cava-devops/main/scripts/cava_system_info.py)
+        ```
+      render: shell

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

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Discussions
+    url: https://github.com/orgs/AustralianCancerDataNetwork/discussions
+    about: Questions and general discussion about the CAVA stack.

pbs_client-0.1.0/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,32 @@
+name: "🚀 Feature Request"
+description: Propose a new feature or enhancement.
+type: "Feature"
+body:
+  - type: checkboxes
+    attributes:
+      label: Pre-flight
+      options:
+        - label: I searched existing issues and this has not been requested before.
+          required: true
+
+  - type: textarea
+    id: problem
+    attributes:
+      label: Problem or motivation
+      description: What are you trying to do that you currently cannot?
+    validations:
+      required: true
+
+  - type: textarea
+    id: proposal
+    attributes:
+      label: Proposed solution
+      description: How would you like this to work?
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives considered
+      description: Other approaches you considered and why you ruled them out.

pbs_client-0.1.0/.github/ISSUE_TEMPLATE/not_working.yml

@@ -0,0 +1,65 @@
+name: "❗ Something is not working"
+description: Something behaves unexpectedly but you are not sure if it is a bug.
+body:
+  - type: checkboxes
+    attributes:
+      label: Pre-flight
+      options:
+        - label: I searched existing issues for this problem.
+          required: true
+
+  - type: textarea
+    id: summary
+    attributes:
+      label: Problem summary
+      description: 1-2 sentences describing what is not working.
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Reproduction
+      description: Steps and/or a minimal code example. Wrap code in triple backticks.
+      placeholder: |
+        1. Import X and call Y with Z
+        2. Observe unexpected behaviour
+
+        ```python
+        # minimal example
+        ```
+    validations:
+      required: true
+
+  - type: textarea
+    id: actual
+    attributes:
+      label: Actual outcome
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected outcome
+    validations:
+      required: true
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: Error messages
+      description: Full traceback if applicable. Formatted automatically.
+      render: python-traceback
+
+  - type: textarea
+    id: system
+    attributes:
+      label: System info
+      description: |
+        Run this in your environment and paste the output:
+
+        ```shell
+        python <(curl -s https://raw.githubusercontent.com/AustralianCancerDataNetwork/cava-devops/main/scripts/cava_system_info.py)
+        ```
+      render: shell

pbs_client-0.1.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,9 @@
+## Summary
+
+<!-- What does this PR do? This text becomes the changelog entry — write it for a reader who will see it months from now, not for the reviewer reading the diff. Leave blank for chore PRs. -->
+
+## Checklist
+
+- [ ] Applied exactly one label (`breaking`, `feature`, `fix`, `dependencies`, or `chore`)
+- [ ] Tests pass locally (`uv run pytest -q`)
+- [ ] Lint passes (`uv run ruff check .`)

pbs_client-0.1.0/.github/release-drafter.yml

@@ -0,0 +1,31 @@
+name-template: 'v$RESOLVED_VERSION'
+tag-template: 'v$RESOLVED_VERSION'
+commitish: main
+
+categories:
+  - title: Breaking Changes
+    labels: ['breaking']
+  - title: Features
+    labels: ['feature']
+  - title: Fixes
+    labels: ['fix']
+  - title: Dependencies
+    labels: ['dependencies']
+
+template: |
+  $CHANGES
+
+change-template: '- **$TITLE** (#$NUMBER) @$AUTHOR'
+
+version-resolver:
+  major:
+    labels: ['breaking']
+  minor:
+    labels: ['feature']
+  patch:
+    labels: ['fix', 'dependencies']
+  default: patch
+
+exclude-labels: ['chore']
+
+autolabeler: []

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

@@ -0,0 +1,10 @@
+name: CI
+on:
+  pull_request:
+    branches: [main]
+    types: [opened, synchronize, reopened, labeled, unlabeled]
+jobs:
+  label-gate:
+    uses: AustralianCancerDataNetwork/cava-devops/.github/workflows/label-gate.yml@main
+  build-test:
+    uses: AustralianCancerDataNetwork/cava-devops/.github/workflows/build-test.yml@main

pbs_client-0.1.0/.github/workflows/merge.yml

@@ -0,0 +1,10 @@
+name: Release Update
+on:
+  pull_request:
+    types: [closed]
+    branches: [main]
+jobs:
+  draft:
+    if: github.event.pull_request.merged == true
+    uses: AustralianCancerDataNetwork/cava-devops/.github/workflows/release-drafter.yml@main
+    secrets: inherit

pbs_client-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,19 @@
+name: Publish
+on:
+  push:
+    tags: ['v*']
+jobs:
+  build:
+    uses: AustralianCancerDataNetwork/cava-devops/.github/workflows/publish.yml@main
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    environment:
+      name: pypi
+      url: https://pypi.org/p/pbs-client
+    steps:
+      - uses: actions/download-artifact@v4
+        with: { name: dist, path: dist/ }
+      - uses: pypa/gh-action-pypi-publish@release/v1

pbs_client-0.1.0/.gitignore

@@ -0,0 +1,147 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$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
+*.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
+
+# Local PBS mirror (generated by `pbs-client sync`, not checked in)
+*.db-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
+
+
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.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
+
+# ruff
+.ruff_cache/
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+oa_system_config.yaml
+data/
+.DS_Store
+*.csv
+_design/
+.vscode/
+old/
+logs/
+notebooks/
+reference/
+TODO.md
+docker/
+*.db
+*.db.*

pbs_client-0.1.0/.importlinter

@@ -0,0 +1,14 @@
+[importlinter]
+root_package = pbs_client
+include_external_packages = True
+
+[importlinter:contract:pbs-client-layers]
+name = pbs-client layers: sync sits on http+db, query sits on db only
+type = layers
+layers =
+    pbs_client.cli
+    pbs_client.sync
+    pbs_client.query
+    pbs_client.db
+    pbs_client.http
+

pbs_client-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,27 @@
+# Contributing
+
+## Development setup
+
+```bash
+uv sync --all-extras --dev
+uv run pytest -q
+uv run ruff check .
+```
+
+## Opening a pull request
+
+1. Apply **exactly one** label before merging:
+
+   | Label | When to use |
+   |---|---|
+   | `breaking` | Public API change, backward-incompatible |
+   | `feature` | New functionality, backward-compatible |
+   | `fix` | Bug fix |
+   | `dependencies` | Dependency version update |
+   | `chore` | CI changes, refactoring, test additions, docs — anything that does not affect the public-facing package. Bypasses the label gate; excluded from the changelog and does not bump the version. |
+
+2. When merging (squash), write a clear extended description in the merge dialog. That text — not the PR's opening description — becomes the changelog entry for this change. Leave it blank for `chore` PRs.
+
+## Versioning and releases
+
+Versions are derived from git tags; there is no version string in any source file. Releases are triggered by a maintainer publishing the standing draft release on the repository's Releases page. There is no automated commit-back to `main`.

pbs_client-0.1.0/NOTICE

@@ -0,0 +1,6 @@
+PBS Public Data API copyright notice:
+
+Permission is granted to use and redistribute this content, as long as all
+copyright statements are retained. Permission is not granted to modify this
+content.
+

pbs_client-0.1.0/PKG-INFO

@@ -0,0 +1,65 @@
+Metadata-Version: 2.5
+Name: pbs-client
+Version: 0.1.0
+Summary: Offline-first client and local mirror for the Australian PBS Public Data API v3
+Author: Australian Cancer Data Network
+License: MIT
+License-File: NOTICE
+Requires-Python: >=3.12
+Requires-Dist: oa-configurator<2.0.0,>=1.2.1
+Requires-Dist: pydantic<3.0,>=2.0
+Requires-Dist: rich>=13.0
+Requires-Dist: sqlalchemy>=2.0.45
+Requires-Dist: typer>=0.12
+Provides-Extra: dev
+Requires-Dist: import-linter>=2.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# pbs-client
+
+`pbs-client` is an offline-first Python client and local SQLite mirror for the Australian PBS Public Data API v3. It mirrors all API resources, retains schedule history locally, and exposes small read helpers for item, restriction/indication, and ATC lookups.
+
+## Quick start
+
+```shell
+uv sync --extra dev
+uv run omop-config configure pbs_client
+uv run pbs-client init-db
+uv run pbs-client sync
+```
+
+The package registers `PBSClientConfig` with `oa-configurator` under the
+`pbs_client` tool name. The configuration wizard creates a `[tools.pbs_client]`
+section and a named generic database entry (`pbs_db`) that can be shared with
+downstream packages such as Groundworkers.
+
+For a non-interactive local SQLite setup, the relevant stack configuration is:
+
+```toml
+[connections.pbs_local]
+dialect = "sqlite"
+database_name = "/absolute/path/to/pbs_client.db"
+
+[databases.pbs_db]
+kind = "generic"
+connection = "pbs_local"
+
+[tools.pbs_client]
+pbs_db = "pbs_db"
+subscription_key = "your-subscription-key"
+```
+
+Set `OA_CONFIG_PATH` before invoking the commands when using a config file
+outside `~/.config/omop/config.toml`. The legacy `--db-path` option remains
+available for local one-off runs and uses the `PBS_CLIENT_*` environment
+variables for API settings.
+
+The public API is deliberately rate limited to one request per twenty seconds. The client enforces that interval process-wide, including retries and page continuations. Tests use local fixtures and never call the API.
+
+Configuration is normally read from `oa-configurator`. Direct library use still
+supports `PBS_CLIENT_SUBSCRIPTION_KEY`, `PBS_CLIENT_DB_PATH`,
+`PBS_CLIENT_BASE_URL`, and `PBS_CLIENT_RATE_LIMIT_SECONDS`. The database
+defaults to `./pbs_client.db` only for that legacy environment-variable path.

pbs_client-0.1.0/README.md

@@ -0,0 +1,45 @@
+# pbs-client
+
+`pbs-client` is an offline-first Python client and local SQLite mirror for the Australian PBS Public Data API v3. It mirrors all API resources, retains schedule history locally, and exposes small read helpers for item, restriction/indication, and ATC lookups.
+
+## Quick start
+
+```shell
+uv sync --extra dev
+uv run omop-config configure pbs_client
+uv run pbs-client init-db
+uv run pbs-client sync
+```
+
+The package registers `PBSClientConfig` with `oa-configurator` under the
+`pbs_client` tool name. The configuration wizard creates a `[tools.pbs_client]`
+section and a named generic database entry (`pbs_db`) that can be shared with
+downstream packages such as Groundworkers.
+
+For a non-interactive local SQLite setup, the relevant stack configuration is:
+
+```toml
+[connections.pbs_local]
+dialect = "sqlite"
+database_name = "/absolute/path/to/pbs_client.db"
+
+[databases.pbs_db]
+kind = "generic"
+connection = "pbs_local"
+
+[tools.pbs_client]
+pbs_db = "pbs_db"
+subscription_key = "your-subscription-key"
+```
+
+Set `OA_CONFIG_PATH` before invoking the commands when using a config file
+outside `~/.config/omop/config.toml`. The legacy `--db-path` option remains
+available for local one-off runs and uses the `PBS_CLIENT_*` environment
+variables for API settings.
+
+The public API is deliberately rate limited to one request per twenty seconds. The client enforces that interval process-wide, including retries and page continuations. Tests use local fixtures and never call the API.
+
+Configuration is normally read from `oa-configurator`. Direct library use still
+supports `PBS_CLIENT_SUBSCRIPTION_KEY`, `PBS_CLIENT_DB_PATH`,
+`PBS_CLIENT_BASE_URL`, and `PBS_CLIENT_RATE_LIMIT_SECONDS`. The database
+defaults to `./pbs_client.db` only for that legacy environment-variable path.

pbs_client-0.1.0/pyproject.toml

@@ -0,0 +1,52 @@
+[project]
+name = "pbs-client"
+dynamic = ["version"]
+description = "Offline-first client and local mirror for the Australian PBS Public Data API v3"
+readme = "README.md"
+requires-python = ">=3.12"
+authors = [{ name = "Australian Cancer Data Network" }]
+license = { text = "MIT" }
+dependencies = [
+  "oa-configurator>=1.2.1,<2.0.0",
+  "pydantic>=2.0,<3.0",
+  "sqlalchemy>=2.0.45",
+  "typer>=0.12",
+  "rich>=13.0",
+]
+
+[project.optional-dependencies]
+dev = [
+  "pytest>=8.0",
+  "pytest-cov>=4.0",
+  "ruff>=0.4",
+  "import-linter>=2.0",
+]
+
+[project.scripts]
+pbs-client = "pbs_client.cli:main"
+
+[project.entry-points."omop.config"]
+pbs_client = "pbs_client.config:PBSClientConfig"
+
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+source = "vcs"
+raw-options = { tag_regex = '^v?(?P<version>[0-9]+\.[0-9]+\.[0-9]+)$' }
+fallback-version = "0.1.0"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/pbs_client"]
+
+[tool.uv]
+cache-keys = [{ file = "pyproject.toml" }, { git = { commit = true, tags = true } }]
+
+[tool.ruff]
+line-length = 100
+target-version = "py312"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-q"

pbs_client-0.1.0/src/pbs_client/__init__.py

@@ -0,0 +1,5 @@
+"""Offline-first client and local mirror for the PBS Public Data API v3."""
+
+from pbs_client.config import PBSClientConfig, PBSSettings, get_pbs_context
+
+__all__ = ["PBSClientConfig", "PBSSettings", "get_pbs_context"]

pbs_client-0.1.0/src/pbs_client/cli/__init__.py

@@ -0,0 +1,6 @@
+"""pbs-client command line entry point."""
+
+from pbs_client.cli.main import app, main
+
+__all__ = ["app", "main"]
+