avios-cli 0.1.0__tar.gz

avios_cli-0.1.0/.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 4
+
+[*.{yml,yaml,toml,json,md}]
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false

avios_cli-0.1.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,25 @@
+---
+name: Bug report
+about: Something isn't working
+title: ""
+labels: bug
+assignees: ""
+---
+
+**What happened**
+A clear description of the bug.
+
+**Command / steps**
+The exact command(s) you ran, e.g. `avios transactions --limit 10`.
+
+**Expected**
+What you expected to happen.
+
+**Environment**
+- avios-cli version (`avios --version`):
+- OS:
+- Python version:
+- Installed the `login` extra? (yes/no)
+
+**Logs / output**
+Paste any error output. **Redact cookies and account details.**

avios_cli-0.1.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,16 @@
+---
+name: Feature request
+about: Suggest an idea or new command
+title: ""
+labels: enhancement
+assignees: ""
+---
+
+**What would you like?**
+A clear description of the feature or command.
+
+**Why**
+The problem it solves or the use case.
+
+**Notes**
+Anything else — e.g. the avios.com/BA page or endpoint it relates to.

avios_cli-0.1.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,23 @@
+<!-- Thanks for contributing! Keep PRs small (< ~1000 lines) and focused. -->
+
+## What & why
+
+<!-- What does this change and why? Link any related issue. -->
+
+## Test plan
+
+```
+uv run ruff check .
+uv run ruff format --check .
+uv run mypy src
+uv run pytest
+```
+
+<!-- Note any manual verification (e.g. `avios login`, `avios tui`). -->
+
+## Checklist
+
+- [ ] Tests added/updated (network/browser mocked)
+- [ ] `ruff`, `mypy`, `pytest` pass locally
+- [ ] Files stay under 1000 lines; diff under ~1000 lines
+- [ ] CHANGELOG updated if user-facing

avios_cli-0.1.0/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "uv"
+    directory: "/"
+    schedule:
+      interval: "weekly"

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

@@ -0,0 +1,44 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    env:
+      # Drives every uv command (overrides .python-version) so the matrix actually
+      # tests each interpreter. uv downloads the interpreter if it's missing.
+      UV_PYTHON: ${{ matrix.python-version }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Lint (ruff)
+        run: uv run ruff check .
+
+      - name: Format check (ruff)
+        run: uv run ruff format --check .
+
+      - name: Type check (mypy)
+        run: uv run mypy src
+
+      - name: Test (pytest)
+        run: uv run pytest

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

@@ -0,0 +1,40 @@
+name: Publish
+
+# Publishes to PyPI when a GitHub Release is published.
+# Uses PyPI Trusted Publishing (OIDC) — no API token needed. Before the first
+# release, configure a trusted publisher for `avios-cli` on PyPI pointing at this
+# workflow. See https://docs.pypi.org/trusted-publishers/
+on:
+  release:
+    types: [published]
+  workflow_dispatch: # allow a manual publish of the current version
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+      - name: Build sdist and wheel
+        run: uv build
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write # required for trusted publishing
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

avios_cli-0.1.0/.gitignore

@@ -0,0 +1,39 @@
+# Byte-compiled / optimized
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+build/
+dist/
+*.egg-info/
+.eggs/
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Test / coverage / type-check caches
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.coverage
+.coverage.*
+htmlcov/
+coverage.xml
+
+# Tooling
+.python-version.local
+
+# Editors / OS
+.idea/
+.vscode/
+*.swp
+.DS_Store
+
+# Concord local work-state (regenerated per machine)
+.concord/
+
+# Playwright browsers (installed out-of-tree, but just in case)
+ms-playwright/

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

@@ -0,0 +1,16 @@
+# Run `uv run pre-commit install` once to enable these hooks locally.
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.9
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-yaml
+      - id: check-toml
+      - id: check-merge-conflict

avios_cli-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

avios_cli-0.1.0/CHANGELOG.md

@@ -0,0 +1,35 @@
+# Changelog
+
+All notable changes to this project are documented here. The format is based on
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres
+to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- Project scaffolding: src-layout `avios` package, hatchling packaging, `avios`
+  console script, ruff + mypy + pytest tooling, GitHub Actions CI (Python
+  3.10–3.13).
+- Config layer (`pydantic-settings`, XDG paths) and pydantic models.
+- Session/cookie layer: `state.json` storage (mode `600`), `AVIOS_COOKIE`
+  override, authenticated `httpx` client, expiry detection.
+- Typed `AviosClient`: balance, transactions (+`--limit`), pending, accounts,
+  profile, overview, and a `raw` escape hatch.
+- Browser-assisted login: `avios login` (Playwright) and
+  `avios login --from-browser` (browser-cookie3); `avios logout`.
+- CLI commands with Rich rendering and `--json` output.
+- Textual TUI dashboard (`avios tui`): gradient ASCII "AVIOS" banner + balance
+  header + scrollable transactions table, non-blocking refresh.
+- OSS project files: CONTRIBUTING, SECURITY, issue/PR templates, PyPI publish
+  workflow, Dependabot.
+- README screenshot of the TUI, generated by `scripts/screenshot.py`.
+
+### Fixed
+- TUI balance line rendered blank: `#balance` padding + border consumed its whole
+  height (content height 0). Adjusted the box so the balance is visible.
+
+### Noted
+- Reward-flight **availability** search is not yet implemented (needs a British
+  Airways capture).
+
+[Unreleased]: https://github.com/alexechoi/avios-cli/commits/main

avios_cli-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,74 @@
+# Contributing to avios-cli
+
+Thanks for your interest! avios-cli is a small, unofficial project — contributions
+of all sizes are welcome.
+
+## Dev setup
+
+Requires Python 3.10+ and [`uv`](https://docs.astral.sh/uv/).
+
+```bash
+git clone https://github.com/alexechoi/avios-cli
+cd avios-cli
+uv sync                       # installs the project + the `dev` dependency-group
+uv run pre-commit install     # optional: auto-lint on commit
+```
+
+For the login flow (Playwright / browser-cookie3):
+
+```bash
+uv sync --extra login
+uv run playwright install chromium
+```
+
+## Checks (run before pushing)
+
+```bash
+uv run ruff check .
+uv run ruff format .
+uv run mypy src
+uv run pytest
+```
+
+CI runs the same checks on Python 3.10–3.13; all must pass.
+
+## Pull requests
+
+- **Keep PRs small** — under ~1000 lines of diff, and keep individual files under
+  1000 lines. Split larger work into a sequence of focused PRs.
+- Write a clear title and description, and include the test commands you ran.
+- Add or update tests for behaviour changes. Network/browser calls are mocked —
+  see `tests/` for patterns (`httpx.MockTransport`, faked `browser_cookie3`,
+  Textual `Pilot`).
+- Commits use a light [Conventional Commits](https://www.conventionalcommits.org/)
+  style (`feat:`, `fix:`, `docs:`, `chore:`, `test:`, `ci:`).
+- PRs are merged with a **merge commit** (history is not squashed).
+
+## Releasing (maintainers)
+
+Releases publish to [PyPI](https://pypi.org/project/avios-cli/) via
+`.github/workflows/publish.yml` using **Trusted Publishing (OIDC)** — no API token.
+
+One-time setup on PyPI (Account → Publishing → *Add a pending publisher*):
+
+| Field | Value |
+| --- | --- |
+| PyPI Project Name | `avios-cli` |
+| Owner | `alexechoi` |
+| Repository name | `avios-cli` |
+| Workflow name | `publish.yml` |
+| Environment name | `pypi` |
+
+To cut a release:
+
+1. Bump `__version__` in `src/avios/__init__.py` and update `CHANGELOG.md`.
+2. Merge to `main`.
+3. Create a GitHub Release with tag `vX.Y.Z` — the workflow builds and publishes.
+   (Or run the **Publish** workflow manually via *workflow_dispatch*.)
+
+## Reverse-engineering note
+
+avios-cli talks to avios.com's private, undocumented endpoints. Shapes can change
+without notice. If you observe a new/changed response, please pin the model in
+`models.py` and add a fixture under `tests/fixtures/`. See [SECURITY.md](SECURITY.md)
+for how credentials are handled.

avios_cli-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Alex Choi
+
+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.

avios_cli-0.1.0/PKG-INFO

@@ -0,0 +1,152 @@
+Metadata-Version: 2.4
+Name: avios-cli
+Version: 0.1.0
+Summary: A CLI and TUI for avios.com — view your Avios balance and transactions from the terminal.
+Project-URL: Homepage, https://github.com/alexechoi/avios-cli
+Project-URL: Repository, https://github.com/alexechoi/avios-cli
+Project-URL: Issues, https://github.com/alexechoi/avios-cli/issues
+Author: Alex Choi
+License-Expression: MIT
+License-File: LICENSE
+Keywords: avios,british-airways,cli,loyalty,terminal,tui
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.27
+Requires-Dist: pydantic-settings>=2.3
+Requires-Dist: pydantic>=2.7
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=13.7
+Requires-Dist: textual>=0.80
+Requires-Dist: typer>=0.12
+Provides-Extra: login
+Requires-Dist: browser-cookie3>=0.19; extra == 'login'
+Requires-Dist: playwright>=1.44; extra == 'login'
+Description-Content-Type: text/markdown
+
+# avios-cli
+
+[![CI](https://github.com/alexechoi/avios-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/alexechoi/avios-cli/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+[![Python](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://www.python.org/)
+
+A **CLI and TUI for [avios.com](https://www.avios.com)** — check your Avios balance,
+browse your transactions and manage your account without leaving the terminal.
+
+> ⚠️ **Unofficial.** This project is not affiliated with, authorised by, or endorsed by
+> Avios, British Airways or IAG Loyalty. It drives the same private endpoints the
+> avios.com website uses, with your own logged-in session. Use at your own risk; it may
+> break at any time and may be against the provider's terms of service.
+
+![avios TUI dashboard](docs/dashboard.svg)
+
+<sub>The <code>avios tui</code> dashboard (demo data). Regenerate with <code>uv run python scripts/screenshot.py</code>.</sub>
+
+## Status
+
+Early alpha, built in the open. See the [roadmap](#roadmap).
+
+## Install
+
+Requires Python 3.10+.
+
+```bash
+uvx avios-cli --help     # try it without installing (recommended)
+# or install it:
+pip install avios-cli
+```
+
+Or from source, for development:
+
+```bash
+git clone https://github.com/alexechoi/avios-cli
+cd avios-cli
+uv sync
+uv run avios --help
+```
+
+## Log in
+
+avios.com has no credential API — login is Auth0 Universal Login behind hCaptcha and
+SMS/passkey MFA — so `avios login` rides a real browser session (like `gh`/`aws`
+login). Install the login extra once:
+
+```bash
+uv sync --extra login          # or: pip install "avios-cli[login]"
+uv run playwright install chromium
+```
+
+Then either open a browser to log in, or import the cookie from a browser you're
+already logged into:
+
+```bash
+avios login                    # opens a browser; log in once, cookie is captured
+avios login --from-browser     # instead, read the avios.com cookie from Chrome
+```
+
+Your session cookie is stored at `~/.config/avios/state.json` (mode `600`). It
+expires after ~a day; just run `avios login` again. Run `avios logout` to remove it.
+
+## Usage
+
+```bash
+avios balance                  # your Avios balance
+avios transactions --limit 20  # recent transactions
+avios pending                  # pending Avios
+avios accounts                 # linked loyalty accounts
+avios overview                 # dashboard summary (raw JSON)
+avios whoami                   # your profile (raw JSON)
+avios raw /manage-avios/api/user/current   # hit any endpoint directly
+```
+
+Add `--json` to `balance`, `transactions`, `pending` or `accounts` for scriptable
+output.
+
+## TUI
+
+```bash
+avios tui
+```
+
+A full-screen dashboard: your balance in the header and a scrollable transactions
+table. Press `r` to refresh, `q` to quit.
+
+## Roadmap
+
+- [x] Project scaffolding, packaging and CI
+- [x] Session + cookie storage layer
+- [x] Typed API client (balance, transactions, accounts, profile)
+- [x] Browser-assisted `avios login`
+- [x] CLI commands
+- [x] Textual TUI dashboard
+- [ ] Reward-flight **availability** search _(coming soon — needs a British Airways capture)_
+
+## Development
+
+```bash
+uv sync            # installs the project + the `dev` dependency-group
+uv run ruff check .
+uv run mypy src
+uv run pytest
+```
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for the full workflow and
+[CHANGELOG.md](CHANGELOG.md) for release notes.
+
+## Security
+
+No passwords are handled or stored — only your session cookie, kept locally at
+`~/.config/avios/state.json` (mode `600`). See [SECURITY.md](SECURITY.md).
+
+## License
+
+[MIT](LICENSE)

avios_cli-0.1.0/README.md

@@ -0,0 +1,117 @@
+# avios-cli
+
+[![CI](https://github.com/alexechoi/avios-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/alexechoi/avios-cli/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+[![Python](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://www.python.org/)
+
+A **CLI and TUI for [avios.com](https://www.avios.com)** — check your Avios balance,
+browse your transactions and manage your account without leaving the terminal.
+
+> ⚠️ **Unofficial.** This project is not affiliated with, authorised by, or endorsed by
+> Avios, British Airways or IAG Loyalty. It drives the same private endpoints the
+> avios.com website uses, with your own logged-in session. Use at your own risk; it may
+> break at any time and may be against the provider's terms of service.
+
+![avios TUI dashboard](docs/dashboard.svg)
+
+<sub>The <code>avios tui</code> dashboard (demo data). Regenerate with <code>uv run python scripts/screenshot.py</code>.</sub>
+
+## Status
+
+Early alpha, built in the open. See the [roadmap](#roadmap).
+
+## Install
+
+Requires Python 3.10+.
+
+```bash
+uvx avios-cli --help     # try it without installing (recommended)
+# or install it:
+pip install avios-cli
+```
+
+Or from source, for development:
+
+```bash
+git clone https://github.com/alexechoi/avios-cli
+cd avios-cli
+uv sync
+uv run avios --help
+```
+
+## Log in
+
+avios.com has no credential API — login is Auth0 Universal Login behind hCaptcha and
+SMS/passkey MFA — so `avios login` rides a real browser session (like `gh`/`aws`
+login). Install the login extra once:
+
+```bash
+uv sync --extra login          # or: pip install "avios-cli[login]"
+uv run playwright install chromium
+```
+
+Then either open a browser to log in, or import the cookie from a browser you're
+already logged into:
+
+```bash
+avios login                    # opens a browser; log in once, cookie is captured
+avios login --from-browser     # instead, read the avios.com cookie from Chrome
+```
+
+Your session cookie is stored at `~/.config/avios/state.json` (mode `600`). It
+expires after ~a day; just run `avios login` again. Run `avios logout` to remove it.
+
+## Usage
+
+```bash
+avios balance                  # your Avios balance
+avios transactions --limit 20  # recent transactions
+avios pending                  # pending Avios
+avios accounts                 # linked loyalty accounts
+avios overview                 # dashboard summary (raw JSON)
+avios whoami                   # your profile (raw JSON)
+avios raw /manage-avios/api/user/current   # hit any endpoint directly
+```
+
+Add `--json` to `balance`, `transactions`, `pending` or `accounts` for scriptable
+output.
+
+## TUI
+
+```bash
+avios tui
+```
+
+A full-screen dashboard: your balance in the header and a scrollable transactions
+table. Press `r` to refresh, `q` to quit.
+
+## Roadmap
+
+- [x] Project scaffolding, packaging and CI
+- [x] Session + cookie storage layer
+- [x] Typed API client (balance, transactions, accounts, profile)
+- [x] Browser-assisted `avios login`
+- [x] CLI commands
+- [x] Textual TUI dashboard
+- [ ] Reward-flight **availability** search _(coming soon — needs a British Airways capture)_
+
+## Development
+
+```bash
+uv sync            # installs the project + the `dev` dependency-group
+uv run ruff check .
+uv run mypy src
+uv run pytest
+```
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for the full workflow and
+[CHANGELOG.md](CHANGELOG.md) for release notes.
+
+## Security
+
+No passwords are handled or stored — only your session cookie, kept locally at
+`~/.config/avios/state.json` (mode `600`). See [SECURITY.md](SECURITY.md).
+
+## License
+
+[MIT](LICENSE)

avios_cli-0.1.0/SECURITY.md

@@ -0,0 +1,31 @@
+# Security Policy
+
+## How avios-cli handles your credentials
+
+- **No passwords are ever handled or stored.** Login happens in a real browser
+  (Auth0 Universal Login + hCaptcha + MFA); avios-cli only captures the resulting
+  **session cookie**.
+- The cookie is stored locally at `~/.config/avios/state.json` with file mode
+  `600` (owner read/write only). It is never transmitted anywhere except to
+  avios.com in the requests you make.
+- `avios logout` deletes the stored session. The cookie also expires on the
+  server side after roughly a day.
+- `AVIOS_COOKIE` may be set to supply a cookie via the environment instead of the
+  stored file — avoid committing it or storing it in shell history.
+
+## Unofficial software
+
+avios-cli is **not affiliated with Avios, British Airways or IAG Loyalty** and
+uses private, undocumented endpoints. Using it may breach the provider's terms of
+service and could affect your account. Use at your own risk.
+
+## Reporting a vulnerability
+
+Please **do not** open a public issue for security problems. Instead, use GitHub's
+private vulnerability reporting:
+**Security → Report a vulnerability** on the repository, or open a private draft
+advisory. We'll acknowledge within a few days.
+
+## Supported versions
+
+This is pre-1.0 software; only the latest release on `main` is supported.