balancing-services 1.6.0__tar.gz

balancing_services-1.6.0/.env.sample

@@ -0,0 +1,15 @@
+# Environment variables for development and publishing
+# Copy this file to .env and fill in your actual tokens
+# Never commit .env to version control!
+
+# API key for Balancing Services API (for running examples/tests)
+# Get your API key from: https://balancing.services
+BALANCING_SERVICES_API_KEY=
+
+# TestPyPI token (for testing releases)
+# Get your token from: https://test.pypi.org/manage/account/token/
+UV_PUBLISH_TOKEN_TESTPYPI=
+
+# Production PyPI token (for production releases)
+# Get your token from: https://pypi.org/manage/account/token/
+UV_PUBLISH_TOKEN_PYPI=

balancing_services-1.6.0/.gitignore

@@ -0,0 +1,80 @@
+# 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/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Virtual environments
+venv/
+env/
+ENV/
+env.bak/
+venv.bak/
+.venv/
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.DS_Store
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# uv
+.uv/
+uv.lock
+
+# Generated from pyproject.toml.draft
+pyproject.toml
+
+# Environment variables (contains secrets)
+.env

balancing_services-1.6.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Balancing Services
+
+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.

balancing_services-1.6.0/PKG-INFO

@@ -0,0 +1,433 @@
+Metadata-Version: 2.4
+Name: balancing-services
+Version: 1.6.0
+Summary: Official Python client for accessing European electricity balancing market data via the Balancing Services REST API
+Project-URL: Homepage, https://balancing.services
+Project-URL: Documentation, https://api.balancing.services/v1/documentation
+Project-URL: Repository, https://github.com/balancing-services/rest-api
+Project-URL: Changelog, https://github.com/balancing-services/rest-api/blob/main/CHANGELOG.md
+Author: Balancing Services Team
+License: MIT
+Keywords: FCR,aFRR,api,balancing,electricity,energy,europe,grid,imbalance,mFRR,market,openapi,power,reserves
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+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 :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: attrs>=23.0.0
+Requires-Dist: httpx<1.0.0,>=0.28.0
+Requires-Dist: python-dateutil<3.0.0,>=2.9.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.8.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=1.0.0; extra == 'dev'
+Requires-Dist: pytest-cov>=6.0.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: respx>=0.22.0; extra == 'dev'
+Requires-Dist: ruff>=0.8.0; extra == 'dev'
+Requires-Dist: types-python-dateutil>=2.9.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Balancing Services Python Client
+
+Python client library for the [Balancing Services REST API](https://api.balancing.services). Access European electricity balancing market data with a modern, type-safe Python interface.
+
+## Features
+
+- **Type-safe**: Full type hints for better IDE support and code quality
+- **Modern Python**: Built with httpx and attrs for async support and clean data models
+- **Auto-generated**: Generated from the official OpenAPI specification
+- **Comprehensive**: Access to all API endpoints and data models
+- **Well-documented**: Inline documentation and usage examples
+
+## Installation
+
+```bash
+uv pip install balancing-services
+```
+
+Or with pip:
+
+```bash
+pip install balancing-services
+```
+
+For development, install from source:
+
+```bash
+cd clients/python
+uv pip install -e .
+```
+
+## Quick Start
+
+```python
+from balancing_services import AuthenticatedClient
+from balancing_services.api.default import get_imbalance_prices
+from balancing_services.models import Area
+from datetime import datetime
+
+# Create an authenticated client
+client = AuthenticatedClient(
+    base_url="https://api.balancing.services/v1",
+    token="YOUR_API_TOKEN"
+)
+
+# Get imbalance prices for Estonia
+response = get_imbalance_prices.sync_detailed(
+    client=client,
+    area=Area.EE,
+    period_start_at=datetime.fromisoformat("2025-01-01T00:00:00Z"),
+    period_end_at=datetime.fromisoformat("2025-01-02T00:00:00Z")
+)
+
+if response.status_code == 200:
+    data = response.parsed
+    print(f"Query period: {data.queried_period.start_at} to {data.queried_period.end_at}")
+    for imbalance_prices in data.data:
+        print(f"Area: {imbalance_prices.area}, Direction: {imbalance_prices.direction}")
+        for price in imbalance_prices.prices:
+            print(f"  {price.period.start_at}: {price.price} {imbalance_prices.currency}")
+```
+
+## Authentication
+
+To obtain an API token:
+- **Email:** info@balancing.services
+- **Website:** https://balancing.services
+
+Include your token when creating the client:
+
+```python
+from balancing_services import AuthenticatedClient
+
+client = AuthenticatedClient(
+    base_url="https://api.balancing.services/v1",
+    token="YOUR_API_TOKEN"
+)
+```
+
+## Usage Examples
+
+### Get Balancing Energy Bids with Pagination
+
+```python
+from balancing_services import AuthenticatedClient
+from balancing_services.api.default import get_balancing_energy_bids
+from balancing_services.models import Area, ReserveType
+from datetime import datetime
+
+client = AuthenticatedClient(base_url="https://api.balancing.services/v1", token="YOUR_TOKEN")
+
+# First page
+response = get_balancing_energy_bids.sync_detailed(
+    client=client,
+    area=Area.EE,
+    period_start_at=datetime.fromisoformat("2025-01-01T00:00:00Z"),
+    period_end_at=datetime.fromisoformat("2025-01-02T00:00:00Z"),
+    reserve_type=ReserveType.AFRR,
+    limit=100
+)
+
+if response.status_code == 200:
+    data = response.parsed
+    print(f"Has more: {data.has_more}")
+
+    # Process first page
+    for bid_group in data.data:
+        for bid in bid_group.bids:
+            print(f"Bid: {bid.volume} MW @ {bid.price} {bid_group.currency}")
+
+    # Get next page if available
+    if data.has_more and data.next_cursor:
+        next_response = get_balancing_energy_bids.sync_detailed(
+            client=client,
+            area=Area.EE,
+            period_start_at=datetime.fromisoformat("2025-01-01T00:00:00Z"),
+            period_end_at=datetime.fromisoformat("2025-01-02T00:00:00Z"),
+            reserve_type=ReserveType.AFRR,
+            cursor=data.next_cursor,
+            limit=100
+        )
+```
+
+### Async Usage
+
+```python
+import asyncio
+from balancing_services import AuthenticatedClient
+from balancing_services.api.default import get_imbalance_prices
+from balancing_services.models import Area
+from datetime import datetime
+
+async def fetch_prices():
+    client = AuthenticatedClient(
+        base_url="https://api.balancing.services/v1",
+        token="YOUR_TOKEN"
+    )
+
+    response = await get_imbalance_prices.asyncio_detailed(
+        client=client,
+        area=Area.EE,
+        period_start_at=datetime.fromisoformat("2025-01-01T00:00:00Z"),
+        period_end_at=datetime.fromisoformat("2025-01-02T00:00:00Z")
+    )
+
+    if response.status_code == 200:
+        return response.parsed
+    return None
+
+# Run async function
+prices = asyncio.run(fetch_prices())
+```
+
+### Error Handling
+
+```python
+from balancing_services import AuthenticatedClient
+from balancing_services.api.default import get_imbalance_prices
+from balancing_services.models import Area
+from datetime import datetime
+
+client = AuthenticatedClient(base_url="https://api.balancing.services/v1", token="YOUR_TOKEN")
+
+response = get_imbalance_prices.sync_detailed(
+    client=client,
+    area=Area.EE,
+    period_start_at=datetime.fromisoformat("2025-01-01T00:00:00Z"),
+    period_end_at=datetime.fromisoformat("2025-01-02T00:00:00Z")
+)
+
+if response.status_code == 200:
+    data = response.parsed
+    # Process successful response
+elif response.status_code == 400:
+    error = response.parsed
+    print(f"Bad request: {error.detail}")
+elif response.status_code == 401:
+    print("Authentication failed - check your API token")
+elif response.status_code == 429:
+    print("Rate limited - please retry later")
+else:
+    print(f"Error {response.status_code}: {response.content}")
+```
+
+## Data Models
+
+All response and request models are fully typed using attrs. Key models include:
+
+- `ImbalancePricesResponse`, `ImbalanceTotalVolumesResponse`
+- `BalancingEnergyVolumesResponse`, `BalancingEnergyPricesResponse`, `BalancingEnergyBidsResponse`
+- `BalancingCapacityBidsResponse`, `BalancingCapacityPricesResponse`, `BalancingCapacityVolumesResponse`
+- Enums: `Area`, `ReserveType`, `Direction`, `Currency`, `ActivationType`, `BidStatus`
+
+## Development
+
+### Regenerating the Client
+
+The client is generated from the OpenAPI specification. To regenerate:
+
+```bash
+cd clients/python
+./generate.sh
+```
+
+### Running Tests
+
+```bash
+# Install development dependencies
+uv pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Run tests with coverage
+pytest --cov=balancing_services --cov-report=html
+```
+
+### Code Quality
+
+```bash
+# Format code
+ruff format .
+
+# Lint code
+ruff check .
+
+# Type checking
+mypy balancing_services
+```
+
+### Automation Scripts
+
+The Python client includes automation scripts for development and publishing:
+
+#### `generate-pyproject.sh`
+Generates `pyproject.toml` from the template with the current version from `openapi.yaml`.
+
+**Note:** The version is stored in `openapi.yaml` (single source of truth). The `pyproject.toml.draft` template contains invalid TOML (`version = __VERSION__` without quotes) to prevent accidental use without proper generation.
+
+```bash
+./generate-pyproject.sh
+```
+
+This script is automatically called by `check.sh` and `test-and-publish.sh`.
+
+#### `check.sh`
+Runs all quality checks in one command:
+
+```bash
+./check.sh
+```
+
+Performs:
+- Generates `pyproject.toml` from draft
+- Runs tests with pytest
+- Runs linting with ruff
+- Runs type checking with mypy
+- Verifies the package builds
+
+#### `test-and-publish.sh`
+Complete publishing workflow with TestPyPI validation:
+
+**Setup:**
+1. Copy `.env.sample` to `.env` and fill in your credentials:
+   ```bash
+   cp .env.sample .env
+   # Edit .env and add:
+   #   BALANCING_SERVICES_API_KEY (required - for testing against live API)
+   #   UV_PUBLISH_TOKEN_TESTPYPI (required)
+   #   UV_PUBLISH_TOKEN_PYPI (required)
+   ```
+
+2. Run the publish script:
+   ```bash
+   ./test-and-publish.sh
+   ```
+
+**Emergency option** - skip API tests if the server is down:
+```bash
+./test-and-publish.sh --skip-api-tests
+```
+⚠️ This skips testing against the live API. Use only in emergencies!
+
+Alternatively, export variables manually:
+```bash
+export BALANCING_SERVICES_API_KEY="your-api-key"
+export UV_PUBLISH_TOKEN_TESTPYPI="your-testpypi-token"
+export UV_PUBLISH_TOKEN_PYPI="your-pypi-token"
+./test-and-publish.sh
+```
+
+**What it does:**
+1. Loads credentials from `.env` (if present)
+2. Verifies all required environment variables are set
+3. Runs quality checks
+4. Publishes to TestPyPI using `UV_PUBLISH_TOKEN_TESTPYPI`
+5. Creates isolated test sandbox
+6. Installs package from TestPyPI
+7. Runs all example scripts against live API using `BALANCING_SERVICES_API_KEY`
+8. Prompts to publish to PyPI using `UV_PUBLISH_TOKEN_PYPI` if tests pass
+9. Verifies production PyPI package by installing and running examples again
+
+**Get your credentials:**
+- API Key: https://balancing.services
+- TestPyPI: https://test.pypi.org/manage/account/token/
+- PyPI: https://pypi.org/manage/account/token/
+
+**For maintainers:** See `../../scripts/README.md` for the complete release workflow.
+
+## Troubleshooting
+
+### Authentication Errors (401)
+
+**Problem:** Receiving 401 Unauthorized responses
+
+**Solutions:**
+- Verify your API token is correct
+- Check that the token is being passed to `AuthenticatedClient`
+- Ensure your token hasn't expired (contact support if needed)
+
+### Bad Request Errors (400)
+
+**Problem:** Receiving 400 Bad Request responses
+
+**Common causes:**
+- Invalid date range (end date before start date)
+- Date range too large
+- Invalid area code or reserve type
+- Malformed datetime strings
+
+**Solution:** Check the error detail in the response for specific information:
+```python
+if response.status_code == 400:
+    error = response.parsed
+    print(f"Error detail: {error.detail}")
+```
+
+### Empty Results
+
+**Problem:** Receiving 200 OK but no data
+
+**Possible reasons:**
+- No data available for the requested period
+- Data not yet published for recent periods
+- Requesting data for a period before data collection started
+
+**Solution:** Try a different time period or check if data exists for your area
+
+### Timeout Issues
+
+**Problem:** Requests timing out
+
+**Solutions:**
+- Increase the client timeout:
+```python
+client = AuthenticatedClient(
+    base_url="https://api.balancing.services/v1",
+    token="YOUR_TOKEN",
+    timeout=30.0  # Increase from default
+)
+```
+- Reduce the date range in your request
+- Use pagination for large datasets
+
+### Type Errors with Enums
+
+**Problem:** Type errors when passing area or reserve type
+
+**Solution:** Use the provided enum classes:
+```python
+from balancing_services.models import Area, ReserveType
+
+# Correct
+area=Area.EE
+
+# Incorrect
+area="EE"  # String might work but not type-safe
+```
+
+## Documentation
+
+- **API Documentation:** https://api.balancing.services/v1/documentation
+- **OpenAPI Spec:** [openapi.yaml](https://github.com/Balancing-Services/rest-api/blob/main/openapi.yaml)
+- **Main Repository:** https://github.com/balancing-services/rest-api
+
+## Support
+
+- **Website:** https://balancing.services
+- **Email:** info@balancing.services
+- **Issues:** [GitHub Issues](https://github.com/balancing-services/rest-api/issues)
+
+## License
+
+MIT License - see [LICENSE](https://github.com/Balancing-Services/rest-api/blob/main/LICENSE) for details.
+
+## Changelog
+
+See [CHANGELOG.md](https://github.com/Balancing-Services/rest-api/blob/main/CHANGELOG.md) for version history and changes.

balancing_services-1.6.0/PUBLISHING.md

@@ -0,0 +1,56 @@
+# Publishing to PyPI
+
+## Prerequisites
+
+- PyPI and TestPyPI accounts with API tokens
+- `uv` installed: `pip install uv`
+
+## Publishing Process
+
+### 1. Pre-release checks
+
+```bash
+cd clients/python
+
+# Update version in pyproject.toml
+# Update CHANGELOG.md
+
+# Run tests
+uv run pytest
+
+# Build
+uv build
+```
+
+### 2. Publish to TestPyPI
+
+```bash
+export UV_PUBLISH_TOKEN="your-testpypi-token"
+uv publish --publish-url https://test.pypi.org/legacy/
+```
+
+Test installation:
+```bash
+uv pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ balancing-services
+```
+
+### 3. Publish to PyPI
+
+```bash
+export UV_PUBLISH_TOKEN="your-pypi-token"
+uv publish
+```
+
+Test installation:
+```bash
+uv pip install balancing-services
+```
+
+### 4. Post-release
+
+```bash
+git tag -a v1.0.0 -m "Release v1.0.0"
+git push origin v1.0.0
+```
+
+Create GitHub release at https://github.com/balancing-services/rest-api/releases