{"id":16237144,"url":"https://github.com/klaasnicolaas/python-solcast-pv","last_synced_at":"2025-03-19T15:31:09.947Z","repository":{"id":242960413,"uuid":"810034881","full_name":"klaasnicolaas/python-solcast-pv","owner":"klaasnicolaas","description":"☀️ Asynchronous Python client for getting solarpanel forecast information","archived":false,"fork":false,"pushed_at":"2025-03-14T06:37:04.000Z","size":1126,"stargazers_count":4,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-16T01:33:53.096Z","etag":null,"topics":["api","async","client","energy","forecast","hacktoberfest","python"],"latest_commit_sha":null,"homepage":"https://solcast.com.au","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/klaasnicolaas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"klaasnicolaas","ko_fi":"klaasnicolaas"}},"created_at":"2024-06-03T23:30:15.000Z","updated_at":"2025-03-14T01:34:35.000Z","dependencies_parsed_at":"2024-09-06T07:33:36.508Z","dependency_job_id":"a3fa166a-7e90-4a83-b77b-88b370151f6a","html_url":"https://github.com/klaasnicolaas/python-solcast-pv","commit_stats":null,"previous_names":["klaasnicolaas/python-solcast-pv"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaasnicolaas%2Fpython-solcast-pv","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaasnicolaas%2Fpython-solcast-pv/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaasnicolaas%2Fpython-solcast-pv/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaasnicolaas%2Fpython-solcast-pv/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/klaasnicolaas","download_url":"https://codeload.github.com/klaasnicolaas/python-solcast-pv/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244003351,"owners_count":20382175,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","async","client","energy","forecast","hacktoberfest","python"],"created_at":"2024-10-10T13:34:35.793Z","updated_at":"2025-03-19T15:31:09.933Z","avatar_url":"https://github.com/klaasnicolaas.png","language":"Python","funding_links":["https://github.com/sponsors/klaasnicolaas","https://ko-fi.com/klaasnicolaas"],"categories":[],"sub_categories":[],"readme":"\u003c!-- Banner --\u003e\n![alt Banner of the Solcast package](https://raw.githubusercontent.com/klaasnicolaas/python-solcast-pv/main/assets/header_solcast_pv-min.png)\n\n\u003c!-- PROJECT SHIELDS --\u003e\n[![GitHub Release][releases-shield]][releases]\n[![Python Versions][python-versions-shield]][pypi]\n![Project Stage][project-stage-shield]\n![Project Maintenance][maintenance-shield]\n[![License][license-shield]](LICENSE)\n\n[![GitHub Activity][commits-shield]][commits-url]\n[![PyPi Downloads][downloads-shield]][downloads-url]\n[![GitHub Last Commit][last-commit-shield]][commits-url]\n[![Open in Dev Containers][devcontainer-shield]][devcontainer]\n\n[![Build Status][build-shield]][build-url]\n[![Typing Status][typing-shield]][typing-url]\n[![Maintainability][maintainability-shield]][maintainability-url]\n[![Code Coverage][codecov-shield]][codecov-url]\n\n\nAsynchronous Python client for [Solcast][solcast].\n\n## About\n\n[Solcast][solcast] provides solar radiation and solar power forecasts, estimated and\nhistorical data. This package allows you to get the data from the [API][solcast-api]\nand use it in your own application.\n\n\u003e [!NOTE]\n\u003e This package is still in development and rooftop forecast is not yet implemented.\n\n## Installation\n\n```bash\npip install solcast-pv\n```\n\n## Datasets\n\n- List of all your created rooftop sites linked to your account.\n- Get rate limits for your account.\n\n\u003cdetails\u003e\n  \u003csummary\u003eCLICK HERE! to see all datasets\u003c/summary\u003e\n\n### Rooftop Site\n\n**Note**: _requesting the list of all your created rooftop sites linked to your account, will not affect your daily rate limit._\n\n| Name | Type | Description |\n| :--- | :--- | :---------- |\n| `name` | `str` | The name of the rooftop site. |\n| `resource_id` | `str` | The unique identifier of the rooftop site. |\n| `install_date` | `datetime` | The installation date of your solar panels. |\n| `capacity` | `float` | The capacity of the solar panels. |\n| `capacity_dc` | `float` | The capacity of the solar panels in DC. |\n| `azimuth` | `int` | The azimuth of the solar panels. |\n| `tilt` | `int` | The tilt of the solar panels. |\n| `loss_factor` | `float` | The loss factor of the solar panels. |\n\n### Rate Limits\n\n**Note**: _requesting the rate limits for your account will not affect your daily rate limit._\n\n| Name | Type | Description |\n| :--- | :--- | :---------- |\n| `daily_limit` | `int` | The daily limit of API calls. |\n| `remaining_daily` | `int` | The remaining daily limit of API calls. |\n| `consumed_daily` | `int` | How many API calls you have consumed today. |\n\u003c/details\u003e\n\n### Example\n\n```python\nimport asyncio\n\nfrom solcast_pv import Solcast, RooftopSite\n\n\nasync def main() -\u003e None:\n    \"\"\"Show example on using this package.\"\"\"\n    async with Solcast(token=\"API_KEY\") as client:\n        rooftops: list[RooftopSite] = await client.get_rooftop_sites()\n        print(rooftops)\n\nif __name__ == \"__main__\":\n    asyncio.run(main())\n```\n\nMore examples can be found in the [examples folder](./examples/).\n\n## Contributing\n\nThis is an active open-source project. We are always open to people who want to\nuse the code or contribute to it.\n\nWe've set up a separate document for our\n[contribution guidelines](CONTRIBUTING.md).\n\nThank you for being involved! :heart_eyes:\n\n## Setting up development environment\n\nThe simplest way to begin is by utilizing the [Dev Container][devcontainer]\nfeature of Visual Studio Code or by opening a CodeSpace directly on GitHub.\nBy clicking the button below you immediately start a Dev Container in Visual Studio Code.\n\n[![Open in Dev Containers][devcontainer-shield]][devcontainer]\n\nThis Python project relies on [Poetry][poetry] as its dependency manager,\nproviding comprehensive management and control over project dependencies.\n\nYou need at least:\n\n- Python 3.11+\n- [Poetry][poetry-install]\n\n### Installation\n\nInstall all packages, including all development requirements:\n\n```bash\npoetry install\n```\n\n_Poetry creates by default an virtual environment where it installs all\nnecessary pip packages_.\n\n### Pre-commit\n\nThis repository uses the [pre-commit][pre-commit] framework, all changes\nare linted and tested with each commit. To setup the pre-commit check, run:\n\n```bash\npoetry run pre-commit install\n```\n\nAnd to run all checks and tests manually, use the following command:\n\n```bash\npoetry run pre-commit run --all-files\n```\n\n### Testing\n\nIt uses [pytest](https://docs.pytest.org/en/stable/) as the test framework. To run the tests:\n\n```bash\npoetry run pytest\n```\n\nTo update the [syrupy](https://github.com/tophat/syrupy) snapshot tests:\n\n```bash\npoetry run pytest --snapshot-update\n```\n\n## License\n\nMIT License\n\nCopyright (c) 2024-2025 Klaas Schoute\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n\n\u003c!-- LINKS FROM PLATFORM --\u003e\n[solcast]: https://solcast.com/\n[solcast-api]: https://docs.solcast.com.au/\n\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n[build-shield]: https://github.com/klaasnicolaas/python-solcast-pv/actions/workflows/tests.yaml/badge.svg\n[build-url]: https://github.com/klaasnicolaas/python-solcast-pv/actions/workflows/tests.yaml\n[codecov-shield]: https://codecov.io/gh/klaasnicolaas/python-solcast-pv/branch/main/graph/badge.svg?token=X4799ZA1V2\n[codecov-url]: https://codecov.io/gh/klaasnicolaas/python-solcast-pv\n[commits-shield]: https://img.shields.io/github/commit-activity/y/klaasnicolaas/python-solcast-pv.svg\n[commits-url]: https://github.com/klaasnicolaas/python-solcast-pv/commits/main\n[devcontainer-shield]: https://img.shields.io/static/v1?label=Dev%20Containers\u0026message=Open\u0026color=blue\u0026logo=visualstudiocode\n[devcontainer]: https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/klaasnicolaas/python-solcast-pv\n[downloads-shield]: https://img.shields.io/pypi/dm/solcast-pv\n[downloads-url]: https://pypistats.org/packages/solcast-pv\n[last-commit-shield]: https://img.shields.io/github/last-commit/klaasnicolaas/python-solcast-pv.svg\n[license-shield]: https://img.shields.io/github/license/klaasnicolaas/python-solcast-pv.svg\n[maintainability-shield]: https://api.codeclimate.com/v1/badges/37e0267f0b2ab438f848/maintainability\n[maintainability-url]: https://codeclimate.com/github/klaasnicolaas/python-solcast-pv/maintainability\n[maintenance-shield]: https://img.shields.io/maintenance/yes/2025.svg\n[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg\n[pypi]: https://pypi.org/project/solcast-pv/\n[python-versions-shield]: https://img.shields.io/pypi/pyversions/solcast-pv\n[releases-shield]: https://img.shields.io/github/release/klaasnicolaas/python-solcast-pv.svg\n[releases]: https://github.com/klaasnicolaas/python-solcast-pv/releases\n[typing-shield]: https://github.com/klaasnicolaas/python-solcast-pv/actions/workflows/typing.yaml/badge.svg\n[typing-url]: https://github.com/klaasnicolaas/python-solcast-pv/actions/workflows/typing.yaml\n\n[poetry-install]: https://python-poetry.org/docs/#installation\n[poetry]: https://python-poetry.org\n[pre-commit]: https://pre-commit.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fklaasnicolaas%2Fpython-solcast-pv","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fklaasnicolaas%2Fpython-solcast-pv","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fklaasnicolaas%2Fpython-solcast-pv/lists"}