copilot-session-usage 0.1.0__tar.gz

copilot_session_usage-0.1.0/.editorconfig

@@ -0,0 +1,29 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.py]
+indent_style = space
+indent_size = 4
+max_line_length = 100
+
+[*.{yml,yaml}]
+indent_style = space
+indent_size = 2
+
+[*.{json,jsonc}]
+indent_style = space
+indent_size = 2
+
+[*.{md,rst}]
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = false
+
+[justfile]
+indent_style = space
+indent_size = 4

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

@@ -0,0 +1,32 @@
+---
+name: Bug report
+about: Report a bug or unexpected behavior
+title: "[BUG] "
+labels: [bug]
+---
+
+## Description
+
+A clear description of the bug.
+
+## Reproduction
+
+Steps to reproduce:
+1. Run `...`
+2. See error
+
+## Expected behavior
+
+What you expected to happen.
+
+## Environment
+
+- OS:
+- Python version:
+- copilot-session-usage version:
+
+## Logs
+
+```
+Paste any relevant output here.
+```

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

@@ -0,0 +1,22 @@
+---
+name: Feature request
+about: Suggest an idea or enhancement
+title: "[FEAT] "
+labels: [enhancement]
+---
+
+## Description
+
+A clear description of the feature or enhancement.
+
+## Motivation
+
+Why is this needed? What problem does it solve?
+
+## Proposed solution
+
+How should this work?
+
+## Alternatives
+
+Any alternative approaches considered.

copilot_session_usage-0.1.0/.github/guidelines/knowledge-base.guidelines.md

@@ -0,0 +1,105 @@
+---
+applyTo: "knowledge/**/*.md"
+description: "How coding agents maintain the OKF knowledge bundle in knowledge/."
+---
+
+# Knowledge Base Maintenance Guidelines
+
+The `knowledge/` directory is an [OKF](https://github.com/gsemet/okf-schema) (Open Knowledge Format) bundle. It is **not** bundled in the wheel — it lives at repo root for agent and maintainer reference only.
+
+## What Is OKF?
+
+OKF is a lightweight convention for organizing markdown knowledge bases with validated YAML frontmatter. Each document has a `type` field that maps to a JSON Schema in `knowledge/_schema/`.
+
+## Schema Files
+
+| Schema | For Documents | Purpose |
+|--------|--------------|---------|
+| `_schema/Concept.schema.yml` | `concepts/*.md` | Core concepts and explanatory documents |
+| `_schema/Playbook.schema.yml` | `guides/*.md` | Step-by-step guides and actionable workflows |
+| `_schema/Reference.schema.yml` | `reference/*.md` | Structured data, schemas, or lookup tables |
+
+## When to Add a New Document
+
+| You want to... | Use type | Put in |
+|----------------|----------|--------|
+| Explain how something works | `Concept` | `knowledge/concepts/` |
+| Provide a step-by-step procedure | `Playbook` | `knowledge/guides/` |
+| Document a format, schema, or lookup table | `Reference` | `knowledge/reference/` |
+| Brainstorm a future feature | `Concept` | `knowledge/ideas/` |
+
+**Important rules**:
+
+- document only what is not trivial for Coding Agents.
+- do not paraphrase existing documentation or code, you can point if needed.
+- focus on explaining how the external world works, like truthful facts, not opinions or speculation.
+- each knowledge file should be focussed, concise, with important information at the top. Avoid long, rambling documents.
+- prefere short, focussed documents with links and relationships.
+
+## Required Frontmatter
+
+Every `.md` file under `knowledge/` (except `index.md` and `log.md`) must have:
+
+```yaml
+---
+type: Concept          # or Playbook, Reference
+title: Human-Readable Title
+description: Short summary of what this document covers.
+tags: [keyword, another-tag]
+timestamp: 2026-07-01T00:00:00Z
+---
+```
+
+Rules:
+
+- `type` must match the `const` in the corresponding schema file.
+- `title` and `description` must be non-empty strings.
+- `tags` is optional but strongly encouraged for searchability.
+- `timestamp` must be ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`).
+
+## After Adding or Editing a File
+
+1. **Run validation:**
+   ```bash
+   just knowledge-validate
+   ```
+2. **Run lint (auto-fixes frontmatter formatting):**
+   ```bash
+   just knowledge-lint
+   ```
+3. **Verify with the check-only variant:**
+   ```bash
+   just knowledge-lint-check
+   ```
+
+All three commands must pass before committing.
+
+## When to Update Existing Documents
+
+| Trigger | Update |
+|---------|--------|
+| New VS Code Copilot version or new event types | `concepts/vscode-copilot-extension.md` |
+| New JSONL fields in debug logs | `reference/debug-log-format.md` |
+| New pricing tiers or model names | `reference/pricing-formats.md` + `models-and-pricing.yml` |
+| Pricing data drift | Run `just refresh-pricing` |
+| New cost-optimization pattern discovered | `concepts/cost-optimization.md` |
+
+## Log Updates
+
+Add a dated entry to `knowledge/log.md` for significant changes (refactors, bug fixes, discoveries). Use plain ISO-8601 date headings:
+
+```markdown
+## 2026-07-01
+
+### brief-topic
+- Bullet describing the change.
+```
+
+Avoid parenthetical annotations in headings — they trigger OKF validation warnings.
+
+## Pre-Commit Checklist
+
+- [ ] New or edited files have valid YAML frontmatter
+- [ ] `just knowledge-validate` passes (0 errors, 0 warnings)
+- [ ] `just knowledge-lint-check` passes
+- [ ] `just preflight` passes (includes knowledge checks)

copilot_session_usage-0.1.0/.github/pull_request_template.md

@@ -0,0 +1,14 @@
+## Summary
+
+Brief description of the change.
+
+## Changes
+
+- List specific changes made.
+
+## Checklist
+
+- [ ] `just preflight` passes locally
+- [ ] Tests added or updated for new behavior
+- [ ] Documentation updated (README, docs/)
+- [ ] Knowledge base validated (`just knowledge-validate`)

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

@@ -0,0 +1,70 @@
+name: CI
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+  workflow_call:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --all-groups
+
+      - name: Run style check
+        run: uv run -- ruff format --check src tests
+
+      - name: Run linter
+        run: uv run -- ruff check src tests
+
+      - name: Run type checker
+        run: uv run -- mypy src
+
+      - name: Run tests with coverage
+        run: uv run -- pytest tests/ --cov=copilot_session_usage --cov-report=xml --cov-fail-under=85
+
+      - name: Upload coverage
+        uses: codecov/codecov-action@v5
+        with:
+          files: ./coverage.xml
+          fail_ci_if_error: false
+
+  cross-platform:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macos-latest, windows-latest]
+        python-version: ["3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install just
+        uses: extractions/setup-just@v2
+
+      - name: Install dependencies
+        run: uv sync --all-groups
+
+      - name: Run preflight
+        run: just preflight

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

@@ -0,0 +1,32 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  ci:
+    uses: ./.github/workflows/ci.yml
+
+  publish:
+    needs: ci
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/copilot-session-usage
+    permissions:
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

copilot_session_usage-0.1.0/.gitignore

@@ -0,0 +1,220 @@
+# 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
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# 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/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+.agents/changes/

copilot_session_usage-0.1.0/AGENTS.md

@@ -0,0 +1,85 @@
+# AGENTS.md — copilot-session-usage
+
+**copilot-session-usage** is a PyPI-installable Python package that extracts VS Code Copilot session cost KPIs from local debug logs.
+
+## Quick Navigation
+
+- **[README](README.md)** — User-facing overview and quickstart
+- **[CONTRIBUTING](CONTRIBUTING.md)** — Developer setup and conventions
+- **[.github/guidelines/knowledge-base.guidelines.md](.github/guidelines/knowledge-base.guidelines.md)** - How to use, update and maintain the knowledge base
+
+## Technology Stack
+
+- **Language**: Python 3.10+
+- **CLI Framework**: Click
+- **YAML Processing**: ruamel.yaml
+- **Package Manager**: uv
+- **Build Tool**: hatchling + hatch-vcs
+- **Task Runner**: just
+
+## Project Structure
+
+```
+copilot-session-usage/
+├── src/copilot_session_usage/      # Main package
+│   ├── __init__.py                 # Version re-export
+│   ├── api.py                      # Public Python API
+│   ├── cli.py                      # Click CLI entry point
+│   ├── _internal/                  # Internal implementation
+│   │   ├── core.py                 # Cost analysis, JSONL parsing, shaping
+│   │   ├── vscode.py               # VS Code workspace discovery
+│   │   └── copilot_cli.py          # Stub for future CLI support
+│   └── data/                       # Bundled pricing data
+│       ├── models-and-pricing.yml
+│       ├── models-and-pricing.lock
+│       └── custom-models-pricing.yml
+├── tests/                          # pytest test suite
+├── docs/                           # Sphinx documentation
+├── knowledge/                      # OKF knowledge base
+├── skills/                         # Agent skill definition
+├── justfile                        # Task automation
+├── pyproject.toml                  # Project configuration
+└── uv.toml                         # uv configuration
+```
+
+## Main Commands
+
+```bash
+just dev              # Install dev dependencies
+just test             # Run unit tests
+just tests-coverage   # Run tests with 85% coverage threshold
+just preflight        # Full validation (format → lint → typecheck → test → coverage)
+just docs             # Build Sphinx docs
+just docs-serve       # Serve docs with auto-reload
+just build            # Build wheel + sdist
+```
+
+## Knowledge Base operations
+
+When user wants you to debug how VS Code, Copilot CLI, works, how their cost,
+billing, pricing works, when you discover important information that you might
+have to remember, you have to ask yourself this questions: Is this information
+worth remembering for me of for other coding agents, potentially run on
+a different developer's machine ?
+
+If you think some discoveries are worth remembering, you have to update the
+knowledge base.
+You have to follow the guidelines in `.github/guidelines/knowledge-base.guidelines.md`
+to understand the rules of the knowledge base in `knowledge/`.
+
+## Key Conventions
+
+- **Public API**: `api.py` — all functions accept optional `agent` parameter for future routing
+- **Internal modules**: `_internal/` — not part of public API
+- **Pricing data**: Bundled in `src/copilot_session_usage/data/`; loaded via `load_pricing()`
+- **Provider routing**: `--agent {vscode,cli}` — `cli` raises `NotImplementedError`
+- **Detail levels**: `minimal` < `compact` < `full`
+- **Output formats**: `json`, `table`, `detailed` (alias for table + full detail)
+
+## Before You Commit
+
+```bash
+just preflight
+```
+
+All checks must pass. Coverage threshold is 85%.

copilot_session_usage-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,49 @@
+# Contributing to copilot-session-usage
+
+## Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/gsemet/copilot-session-usage
+cd copilot-session-usage
+
+# Install dependencies (uses uv)
+just dev
+```
+
+## Development workflow
+
+```bash
+# Run tests
+just test
+
+# Run full validation
+just preflight
+
+# Build documentation
+just docs
+
+# Serve docs with auto-reload
+just docs-serve
+```
+
+## Code style
+
+- **Formatter**: ruff (line length 100)
+- **Linter**: ruff, ty, mypy
+- **Type checker**: mypy (strict)
+- **Test runner**: pytest with pytest-cov
+
+## Adding features
+
+1. Add or update code in `src/copilot_session_usage/`
+2. Add tests in `tests/`
+3. Update documentation in `docs/source/`
+4. Run `just preflight` to validate
+5. Submit a pull request
+
+## Release process
+
+1. Tag a release: `git tag v1.2.3`
+2. Push tags: `git push --tags`
+3. CI builds and publishes to PyPI via OIDC

copilot_session_usage-0.1.0/LICENSE

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