solcast-pv 0.1.0

Asynchronous Python client for getting forecast data from Solcast

Asynchronous Python client for Solcast.

About

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

[!NOTE] This package is still in development and rooftop forecast is not yet implemented.

Installation

pip install solcast-pv

Datasets

• List of all your created rooftop sites linked to your account.
• Get rate limits for your account.

CLICK HERE! to see all datasets

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.

Example

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())

More examples can be found in the examples folder.

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.

Thank you for being involved! :heart_eyes:

Setting up development environment

The simplest way to begin is by utilizing the Dev Container 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.

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

You need at least:

• Python 3.11+
• Poetry

Install all packages, including all development requirements:

poetry install

Poetry creates by default an virtual environment where it installs all necessary pip packages, to enter or exit the venv run the following commands:

poetry shell
exit

Setup the pre-commit check, you must run this inside the virtual environment:

pre-commit install

Now you're all set to get started!

As this repository uses the pre-commit framework, all changes are linted and tested with each commit. You can run all checks and tests manually, using the following command:

poetry run pre-commit run --all-files

To run just the Python tests:

poetry run pytest

To update the syrupy snapshot tests:

poetry run pytest --snapshot-update

License

MIT License

Copyright (c) 2024 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.