Metadata-Version: 2.4
Name: solcast-pv
Version: 1.0.0
Summary: Asynchronous Python client for getting forecast data from Solcast
License-Expression: MIT
License-File: LICENSE
Keywords: api,async,client,solcast,forecast,energy,solar
Author: Klaas Schoute
Author-email: hello@student-techlife.com
Maintainer: Klaas Schoute
Maintainer-email: hello@student-techlife.com
Requires-Python: >=3.12
Classifier: Framework :: AsyncIO
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: aiohttp (>=3.0.0)
Requires-Dist: yarl (>=1.6.0)
Project-URL: Bug Tracker, https://github.com/klaasnicolaas/python-solcast-pv/issues
Project-URL: Changelog, https://github.com/klaasnicolaas/python-solcast-pv/releases
Project-URL: Documentation, https://github.com/klaasnicolaas/python-solcast-pv
Project-URL: Homepage, https://github.com/klaasnicolaas/python-solcast-pv
Project-URL: Repository, https://github.com/klaasnicolaas/python-solcast-pv
Description-Content-Type: text/markdown

<!-- Banner -->
![alt Banner of the Solcast package](https://raw.githubusercontent.com/klaasnicolaas/python-solcast-pv/main/assets/header_solcast_pv-min.png)

<!-- PROJECT SHIELDS -->
[![GitHub Release][releases-shield]][releases]
[![Python Versions][python-versions-shield]][pypi]
![Project Stage][project-stage-shield]
![Project Maintenance][maintenance-shield]
[![License][license-shield]](LICENSE)

[![GitHub Activity][commits-shield]][commits-url]
[![PyPi Downloads][downloads-shield]][downloads-url]
[![GitHub Last Commit][last-commit-shield]][commits-url]
[![Open in Dev Containers][devcontainer-shield]][devcontainer]

[![Build Status][build-shield]][build-url]
[![Typing Status][typing-shield]][typing-url]
[![Code Coverage][codecov-shield]][codecov-url]
[![OpenSSF Scorecard][scorecard-shield]][scorecard-url]

Asynchronous Python client for [Solcast][solcast].

## About

[Solcast][solcast] provides solar radiation and solar power forecasts, estimated and
historical data. This package allows you to get the data from the [API][solcast-api]
and use it in your own application.

Rooftop forecasts are supported for Solcast hobbyist accounts.

## Installation

```bash
pip install solcast-pv
```

## Datasets

- List of all your created rooftop sites linked to your account.
- Get rate limits for your account.
- Fetch rooftop forecasts, including central, lower and upper power estimates.

<details>
  <summary>CLICK HERE! to see all datasets</summary>

### Rooftop Site

**Note**: _requesting the list of all your created rooftop sites linked to your account, will not affect your daily rate limit._

| Name | Type | Description |
| :--- | :--- | :---------- |
| `name` | `str` | The name of the rooftop site. |
| `resource_id` | `str` | The unique identifier of the rooftop site. |
| `install_date` | `datetime` | The installation date of your solar panels. |
| `capacity` | `float` | The capacity of the solar panels. |
| `capacity_dc` | `float` | The capacity of the solar panels in DC. |
| `azimuth` | `int` | The azimuth of the solar panels. |
| `tilt` | `int` | The tilt of the solar panels. |
| `loss_factor` | `float` | The loss factor of the solar panels. |

### Rate Limits

**Note**: _requesting the rate limits for your account will not affect your daily rate limit._

| Name | Type | Description |
| :--- | :--- | :---------- |
| `daily_limit` | `int` | The daily limit of API calls. |
| `remaining_daily` | `int` | The remaining daily limit of API calls. |
| `consumed_daily` | `int` | How many API calls you have consumed today. |
</details>

### Example

```python
import asyncio

from solcast_pv import Solcast, RooftopSite


async def main() -> None:
    """Show example on using this package."""
    async with Solcast(token="API_KEY") as client:
        rooftops: list[RooftopSite] = await client.get_rooftop_sites()
        print(rooftops)


if __name__ == "__main__":
    asyncio.run(main())
```

### Rooftop forecast

```python
async with Solcast(token="API_KEY", timezone="Europe/Amsterdam") as client:
    forecast = await client.get_rooftop_forecast("ROOFTOP_RESOURCE_ID", hours=48)
    print(forecast.total_energy_forecast_today)  # kWh, local calendar day
    print(forecast.power_forecast_now)  # W
    print(forecast.energy_forecast_current_hour)  # kWh, next elapsed hour
```

Forecast dictionaries contain average power in **kW**, keyed by interval end in UTC. Energy calculations use each interval's duration and include partial intervals. Calendar-day calculations use the selected timezone, including 23- and 25-hour days. Peak-time methods return the end of the peak interval in that timezone and raise `RuntimeError` when no interval is available.

Each forecast call makes one API request. The client does not poll or retry requests automatically. Hobbyist accounts currently allow up to **10 requests per UTC day**; schedule and cache requests in your application, accounting for all rooftop sites. HTTP 429 raises `SolcastRateLimitError` (a subclass of `SolcastConnectionError`). Malformed forecast data raises `SolcastResultsError`. See the [official hobbyist API documentation](https://docs.solcast.com.au/docs/section/rooftop-sites-hobbyist).

Site listing and usage-allowance methods remain available for compatible accounts; their availability can differ from the documented forecast endpoint.

More examples can be found in the [examples folder](./examples/).

## Contributing

This is an active open-source project. We are always open to people who want to
use the code or contribute to it.

We've set up a separate document for our
[contribution guidelines](CONTRIBUTING.md).

Thank you for being involved! :heart_eyes:

## Setting up development environment

The simplest way to begin is by utilizing the [Dev Container][devcontainer]
feature of Visual Studio Code or by opening a CodeSpace directly on GitHub.
By clicking the button below you immediately start a Dev Container in Visual Studio Code.

[![Open in Dev Containers][devcontainer-shield]][devcontainer]

This Python project relies on [Poetry][poetry] as its dependency manager,
providing comprehensive management and control over project dependencies.

You need at least:

- Python 3.12+
- [Poetry][poetry-install]

### Installation

Install all packages, including all development requirements:

```bash
poetry install
```

_Poetry creates by default an virtual environment where it installs all
necessary pip packages_.

### Prek

This repository uses the [prek][prek] framework, all changes
are linted and tested with each commit. To setup the prek check, run:

```bash
poetry run prek install
```

And to run all checks and tests manually, use the following command:

```bash
poetry run prek run --all-files
```

### Testing

It uses [pytest](https://docs.pytest.org/en/stable/) as the test framework. To run the tests:

```bash
poetry run pytest
```

To update the [syrupy](https://github.com/tophat/syrupy) snapshot tests:

```bash
poetry run pytest --snapshot-update
```

## License

MIT License

Copyright (c) 2024-2026 Klaas Schoute

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.


<!-- LINKS FROM PLATFORM -->
[solcast]: https://solcast.com/
[solcast-api]: https://docs.solcast.com.au/


<!-- MARKDOWN LINKS & IMAGES -->
[build-shield]: https://github.com/klaasnicolaas/python-solcast-pv/actions/workflows/tests.yaml/badge.svg
[build-url]: https://github.com/klaasnicolaas/python-solcast-pv/actions/workflows/tests.yaml
[codecov-shield]: https://codecov.io/gh/klaasnicolaas/python-solcast-pv/branch/main/graph/badge.svg?token=X4799ZA1V2
[codecov-url]: https://codecov.io/gh/klaasnicolaas/python-solcast-pv
[commits-shield]: https://img.shields.io/github/commit-activity/y/klaasnicolaas/python-solcast-pv.svg
[commits-url]: https://github.com/klaasnicolaas/python-solcast-pv/commits/main
[devcontainer-shield]: https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode
[devcontainer]: https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/klaasnicolaas/python-solcast-pv
[downloads-shield]: https://img.shields.io/pypi/dm/solcast-pv
[downloads-url]: https://pypistats.org/packages/solcast-pv
[last-commit-shield]: https://img.shields.io/github/last-commit/klaasnicolaas/python-solcast-pv.svg
[license-shield]: https://img.shields.io/github/license/klaasnicolaas/python-solcast-pv.svg
[maintenance-shield]: https://img.shields.io/maintenance/yes/2026.svg
[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg
[pypi]: https://pypi.org/project/solcast-pv/
[python-versions-shield]: https://img.shields.io/pypi/pyversions/solcast-pv
[releases-shield]: https://img.shields.io/github/release/klaasnicolaas/python-solcast-pv.svg
[releases]: https://github.com/klaasnicolaas/python-solcast-pv/releases
[typing-shield]: https://github.com/klaasnicolaas/python-solcast-pv/actions/workflows/typing.yaml/badge.svg
[typing-url]: https://github.com/klaasnicolaas/python-solcast-pv/actions/workflows/typing.yaml

[poetry-install]: https://python-poetry.org/docs/#installation
[poetry]: https://python-poetry.org
[prek]: https://github.com/j178/prek
[scorecard-shield]: https://api.scorecard.dev/projects/github.com/klaasnicolaas/python-solcast-pv/badge
[scorecard-url]: https://scorecard.dev/viewer/?uri=github.com/klaasnicolaas/python-solcast-pv

