Skip to content

docs: add implementation status table to README #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tommed merged 2 commits into from
Mar 15, 2026
Merged

docs: add implementation status table to README #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4336b69
docs: add implementation status table to README
tommed Mar 15, 2026
868b8e0
Update CLAUDE.md
tommed Mar 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,7 @@ Use pyproject.toml with hatchling or setuptools as the build backend. Don't use

## Definition of Done

- Implementation status updated in @README.md
- Update tests to include new/changed work, aim for >80% code coverage, but prioritise good tests
- Run tests and ensure they pass using `make ci`
- If anything changed that would impact the notebooks, run `make execute-notebooks` to update their output
Expand Down
17 changes: 11 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,19 @@ Handles 15-minute MTU resolution, rate limiting, response caching, timezone norm
- **Type-safe** — strict mypy compliance, Pydantic v2 models
- **No floats for money** — all prices and volumes use `Decimal`

## Supported data sources
## Status

| Exchange | Data types |
| Component | |
|---|---|
| Nord Pool | Day-ahead prices, intraday |
| ENTSO-E | Day-ahead prices, generation (actual & forecast), load, cross-border flows |
| EPEX SPOT | Day-ahead prices, intraday |
| EEX | Futures, spot |
| Nord Pool — day-ahead prices | ✅ |
| Core types & exceptions | ✅ |
| Unified `NexaClient` | 🚧 |
| ENTSO-E client | ⬜ |
| EPEX SPOT client | ⬜ |
| EEX client | ⬜ |
| Response caching | ⬜ |
| Rate limiting | ⬜ |
| Timezone normalisation | ⬜ |

## Installation

Expand Down
Loading