Skip to main content

a simple Python SDK for the Solcast API

Project description

Solcast API Python SDK

Python SDK to access the Solcast API

Docs Tests Publish 📦 to PyPI


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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

solcast-1.3.0.tar.gz (2.3 MB view details)

Uploaded Source

Built Distribution

solcast-1.3.0-py3-none-any.whl (11.6 kB view details)

Uploaded Python 3

File details

Details for the file solcast-1.3.0.tar.gz.

File metadata

  • Download URL: solcast-1.3.0.tar.gz
  • Upload date:
  • Size: 2.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for solcast-1.3.0.tar.gz
Algorithm Hash digest
SHA256 a72c0895ef072b67b0c4265b35456a4a25871a7fc1ad40dd46059fd3f9045829
MD5 ec5f9fcff10f23895e226fa812dcf657
BLAKE2b-256 325cd23295f6252a739442fe3b1a1f29e8ebcec38355f3912eb4c37424b868b0

See more details on using hashes here.

File details

Details for the file solcast-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: solcast-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 11.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for solcast-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 34c222d22e5dd86cdc4f85da7e84d4965de93e404877b952f5b35aacedb19053
MD5 37732a634a42728b0bb4567aabaf1405
BLAKE2b-256 62894075aaf0d94247b48bdd9ae08b9bc7ed401b91d314dce07c6904c311c0fc

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page