a simple Python SDK for the Solcast API
Project description
Solcast API Python SDK
Python SDK to access the Solcast API
Documentation: https://solcast.github.io/solcast-api-python-sdk/
Install
pip install solcast
or from source:
git clone https://github.com/Solcast/solcast-api-python-sdk.git
cd solcast-api-python-sdk
pip install .
The vanilla version doesn't have any dependency. For full functionality,
for example for getting the data into DataFrames, and for development, use the [all] tag:
pip install .[all] for the dev libs
Basic Usage
from solcast import live
df = live.radiation_and_weather(
latitude=-33.856784,
longitude=151.215297,
output_parameters=['air_temp', 'dni', 'ghi']
).to_pandas()
Don't forget to set your account Api Key with:
export SOLCAST_API_KEY={your commercial api_key}
Contributing
Tests are run against the Solcast API, you will need an API key to run them.
They are executed on unmetered locations and as such won't consume your requests.
pytest tests
Formatters and Linters
| Language | Formatter/Linter |
|---|---|
yaml |
yamlls |
toml |
taplo |
python |
black |
Recommended Python Development Version
Develop on the oldest supported Python version.
uv python pin 3.8
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file solcast-1.3.1.tar.gz.
File metadata
- Download URL: solcast-1.3.1.tar.gz
- Upload date:
- Size: 3.3 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
841416454351329a08b4240cc0889e0bec8a00836faf2263996bc889a434ee89
|
|
| MD5 |
121368263f554d985d521e7e8f6006f7
|
|
| BLAKE2b-256 |
7842ef6209b9d99725e01ac23a922f987e84777239202fabc46f3f1e9fd06563
|
File details
Details for the file solcast-1.3.1-py3-none-any.whl.
File metadata
- Download URL: solcast-1.3.1-py3-none-any.whl
- Upload date:
- Size: 12.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
87e98c1a442f3e0cb1c32bce0c389f32e1de8da7235b5fe6fa73298a1aebd892
|
|
| MD5 |
8d5d05c5614d2e7b013ff689d5337df0
|
|
| BLAKE2b-256 |
26ebfb1497673a58ab2940379de0ccbad30cd31184ee441c2a387f77ac09b8ee
|