python-entsoe 0.2.0__tar.gz → 0.3.1__tar.gz

python_entsoe-0.3.1/.devcontainer/devcontainer.json

@@ -0,0 +1,16 @@
+{
+  "name": "python-entsoe",
+  "image": "mcr.microsoft.com/devcontainers/python:3.13",
+  "features": {
+    "ghcr.io/astral-sh/uv-devcontainer-features/uv": {}
+  },
+  "postCreateCommand": "uv sync --dev",
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "ms-python.python",
+        "ms-toolsai.jupyter"
+      ]
+    }
+  }
+}

{python_entsoe-0.2.0 → python_entsoe-0.3.1}/.github/workflows/publish.yml

@@ -2,7 +2,7 @@ name: Publish to PyPI
 
 on:
   push:
-    branches: [main]
+    tags: ["v*"]
 
 jobs:
   publish:

{python_entsoe-0.2.0 → python_entsoe-0.3.1}/.gitignore

@@ -36,3 +36,8 @@ htmlcov/
 # OS
 .DS_Store
 Thumbs.db
+output/
+examples/generators/
+
+# Development & testing
+random/

python_entsoe-0.3.1/CLAUDE.md

@@ -0,0 +1,46 @@
+# python-entsoe
+
+Python client for the ENTSO-E Transparency Platform API.
+
+## Environment
+
+- **Python**: ≥3.13, managed with `uv`
+- **API key**: stored in `.env` as `ENTSOE_API_KEY`
+- Run scripts: `uv run python <script>`
+- Run tests: `uv run pytest`
+
+## PyPI Publishing
+
+Publishing is **tag-based only**. Pushing to `main` does NOT trigger a release.
+
+```bash
+# 1. Bump version in pyproject.toml
+# 2. Commit the version bump
+# 3. Tag and push
+git tag v0.3.0
+git push origin main --tags
+```
+
+The GitHub Actions workflow (`.github/workflows/publish.yml`) uses OIDC trusted publishing — no tokens needed.
+
+## Example Notebooks
+
+Notebooks in `examples/` are **generated** — do not edit them directly.
+
+### Workflow
+
+```bash
+# 1. Edit the notebook definitions
+#    → scripts/generate_notebooks.py
+
+# 2. Generate clean notebooks (no outputs)
+uv run python scripts/generate_notebooks.py
+
+# 3. Generate + execute (saves outputs for GitHub rendering)
+uv run python scripts/generate_notebooks.py --execute
+
+# 4. Force re-execution (even if already executed)
+uv run python scripts/generate_notebooks.py --execute --force
+```
+
+Execution is **idempotent** — notebooks with existing outputs are skipped unless `--force` is passed. Requires `ENTSOE_API_KEY` in environment.

{python_entsoe-0.2.0 → python_entsoe-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-entsoe
-Version: 0.2.0
+Version: 0.3.1
 Summary: Python client for the ENTSO-E Transparency Platform API
 Project-URL: Repository, https://github.com/datons/python-entsoe
 Author-email: jsulopzs <jesus.lopez@datons.com>
@@ -12,7 +12,7 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Scientific/Engineering
-Requires-Python: >=3.13
+Requires-Python: >=3.10
 Requires-Dist: pandas>=2.0
 Requires-Dist: requests>=2.28
 Description-Content-Type: text/markdown
@@ -136,50 +136,19 @@ df = client.transmission.crossborder_flows(
 df = client.balancing.imbalance_prices(start, end, country="FR")
 ```
 
-## Country Codes
+## Codes & Dimensions
 
-Use standard ISO codes. Some bidding zones have specific codes:
+All ENTSO-E codes (areas, PSR types, process types, business types, price categories, etc.) are defined as structured registries in [`_mappings.py`](https://github.com/datons/python-entsoe/blob/main/src/entsoe/_mappings.py). Each entry has a `name` (DataFrame output), `slug` (programmatic identifier), and `description`.
 
-| Code | Area |
-|------|------|
-| `FR` | France |
-| `DE_LU` | Germany/Luxembourg (bidding zone) |
-| `ES` | Spain |
-| `NL` | Netherlands |
-| `BE` | Belgium |
-| `IT` | Italy |
-| `IT_NORTH` | Italy North |
-| `NO_1` .. `NO_5` | Norway zones |
-| `SE_1` .. `SE_4` | Sweden zones |
-| `DK_1`, `DK_2` | Denmark zones |
+**Country codes** — use standard ISO codes. Some bidding zones have specific codes (`DE_LU`, `IT_NORTH`, `NO_1`–`NO_5`, `SE_1`–`SE_4`, `DK_1`/`DK_2`).
 
 > **Note:** For day-ahead prices and balancing data, use `DE_LU` instead of `DE`. See [data availability notes](docs/data-availability.md) for details.
 
-Full list of 60+ supported areas in [`_mappings.py`](src/entsoe/_mappings.py).
-
-## PSR Types (Fuel Types)
-
-Use PSR codes to filter generation by fuel type:
-
-| Code | Fuel Type |
-|------|-----------|
-| `B01` | Biomass |
-| `B04` | Fossil Gas |
-| `B05` | Fossil Hard coal |
-| `B06` | Fossil Oil |
-| `B10` | Hydro Pumped Storage |
-| `B11` | Hydro Run-of-river |
-| `B12` | Hydro Water Reservoir |
-| `B14` | Nuclear |
-| `B16` | Solar |
-| `B18` | Wind Offshore |
-| `B19` | Wind Onshore |
-
-Full list in [`_mappings.py`](src/entsoe/_mappings.py). Human-readable names available via:
+**PSR types** — filter generation by fuel type with codes like `B16` (Solar) or slugs like `"solar"`:
 
 ```python
-from entsoe._mappings import PSR_TYPES
-print(PSR_TYPES["B16"])  # "Solar"
+from entsoe import PSR_TYPES
+PSR_TYPES["B16"]  # {'name': 'Solar', 'slug': 'solar', 'description': 'Solar'}
 ```
 
 ## Timestamps
@@ -239,10 +208,15 @@ See the [`examples/`](examples/) directory for Jupyter notebooks with plotly vis
 - [`transmission.ipynb`](examples/transmission.ipynb) — cross-border flows, bidirectional charts, NTC
 - [`balancing.ipynb`](examples/balancing.ipynb) — imbalance prices, multi-country, distribution
 
+## Documentation
+
+- [**Code Registries**](https://github.com/datons/python-entsoe/blob/main/src/entsoe/_mappings.py) — All ENTSO-E codes and their meanings (areas, PSR types, process types, business types, price categories)
+- [**Data Availability**](docs/data-availability.md) — Known issues, geographic coverage, and API quirks
+
 ## Development
 
 ```bash
-git clone https://github.com/jsulopzs/python-entsoe.git
+git clone https://github.com/datons/python-entsoe.git
 cd python-entsoe
 uv sync
 

{python_entsoe-0.2.0 → python_entsoe-0.3.1}/README.md

@@ -117,50 +117,19 @@ df = client.transmission.crossborder_flows(
 df = client.balancing.imbalance_prices(start, end, country="FR")
 ```
 
-## Country Codes
-
-Use standard ISO codes. Some bidding zones have specific codes:
-
-| Code | Area |
-|------|------|
-| `FR` | France |
-| `DE_LU` | Germany/Luxembourg (bidding zone) |
-| `ES` | Spain |
-| `NL` | Netherlands |
-| `BE` | Belgium |
-| `IT` | Italy |
-| `IT_NORTH` | Italy North |
-| `NO_1` .. `NO_5` | Norway zones |
-| `SE_1` .. `SE_4` | Sweden zones |
-| `DK_1`, `DK_2` | Denmark zones |
+## Codes & Dimensions
 
-> **Note:** For day-ahead prices and balancing data, use `DE_LU` instead of `DE`. See [data availability notes](docs/data-availability.md) for details.
-
-Full list of 60+ supported areas in [`_mappings.py`](src/entsoe/_mappings.py).
-
-## PSR Types (Fuel Types)
+All ENTSO-E codes (areas, PSR types, process types, business types, price categories, etc.) are defined as structured registries in [`_mappings.py`](https://github.com/datons/python-entsoe/blob/main/src/entsoe/_mappings.py). Each entry has a `name` (DataFrame output), `slug` (programmatic identifier), and `description`.
 
-Use PSR codes to filter generation by fuel type:
+**Country codes** — use standard ISO codes. Some bidding zones have specific codes (`DE_LU`, `IT_NORTH`, `NO_1`–`NO_5`, `SE_1`–`SE_4`, `DK_1`/`DK_2`).
 
-| Code | Fuel Type |
-|------|-----------|
-| `B01` | Biomass |
-| `B04` | Fossil Gas |
-| `B05` | Fossil Hard coal |
-| `B06` | Fossil Oil |
-| `B10` | Hydro Pumped Storage |
-| `B11` | Hydro Run-of-river |
-| `B12` | Hydro Water Reservoir |
-| `B14` | Nuclear |
-| `B16` | Solar |
-| `B18` | Wind Offshore |
-| `B19` | Wind Onshore |
+> **Note:** For day-ahead prices and balancing data, use `DE_LU` instead of `DE`. See [data availability notes](docs/data-availability.md) for details.
 
-Full list in [`_mappings.py`](src/entsoe/_mappings.py). Human-readable names available via:
+**PSR types** — filter generation by fuel type with codes like `B16` (Solar) or slugs like `"solar"`:
 
 ```python
-from entsoe._mappings import PSR_TYPES
-print(PSR_TYPES["B16"])  # "Solar"
+from entsoe import PSR_TYPES
+PSR_TYPES["B16"]  # {'name': 'Solar', 'slug': 'solar', 'description': 'Solar'}
 ```
 
 ## Timestamps
@@ -220,10 +189,15 @@ See the [`examples/`](examples/) directory for Jupyter notebooks with plotly vis
 - [`transmission.ipynb`](examples/transmission.ipynb) — cross-border flows, bidirectional charts, NTC
 - [`balancing.ipynb`](examples/balancing.ipynb) — imbalance prices, multi-country, distribution
 
+## Documentation
+
+- [**Code Registries**](https://github.com/datons/python-entsoe/blob/main/src/entsoe/_mappings.py) — All ENTSO-E codes and their meanings (areas, PSR types, process types, business types, price categories)
+- [**Data Availability**](docs/data-availability.md) — Known issues, geographic coverage, and API quirks
+
 ## Development
 
 ```bash
-git clone https://github.com/jsulopzs/python-entsoe.git
+git clone https://github.com/datons/python-entsoe.git
 cd python-entsoe
 uv sync