aioelectricitymaps
Async Python 3 wrapper for Electricity Maps
Science Score: 26.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (16.1%) to scientific vocabulary
Keywords
Repository
Async Python 3 wrapper for Electricity Maps
Basic Info
Statistics
- Stars: 10
- Watchers: 1
- Forks: 2
- Open Issues: 2
- Releases: 0
Topics
Metadata Files
README.md
aioelectricitymaps
Asynchronous Python client for Electricity Maps.
About
This package allows you to fetch data from electricitymaps.com.
Installation
bash
pip install aioelectricitymaps
Usage
```python import asyncio
from aioelectricitymaps import ElectricityMaps, ZoneRequest
async def main() -> None: """Run the example.""" async with ElectricityMaps(token="abc123") as em: response = await em.latestcarbonintensity(ZoneRequest("DE"))
print(f"Carbon intensity in Germany: {response.carbon_intensity} gCO2eq/kWh")
if name == "main": asyncio.run(main()) ```
Changelog & Releases
This repository keeps a change log using GitHub's releases functionality. The format of the log is based on Keep a Changelog.
Releases are based on Semantic Versioning, and use the format
of MAJOR.MINOR.PATCH. In a nutshell, the version will be incremented
based on the following:
MAJOR: Incompatible or major changes.MINOR: Backwards-compatible new features and enhancements.PATCH: Backwards-compatible bugfixes and package updates.
Contributing
This is an active open-source project. I am always open to people who want to use the code or contribute to it.
Thank you for being involved! :heart_eyes:
Setting up development environment
This Python project is fully managed using the Poetry dependency manager. But also relies on the use of NodeJS for certain checks during development.
You need at least:
- Python 3.11+
- Poetry
- NodeJS 20+ (including NPM)
To install all packages, including all development requirements:
bash
npm install
poetry install
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:
bash
poetry run pre-commit run --all-files
To run just the Python tests:
bash
poetry run pytest
Authors & contributors
The content is by Jan-Philipp Benecke.
For a full list of all authors and contributors, check the contributor's page.
License
MIT License
Copyright (c) 2023-2025 Jan-Philipp Benecke
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.
Owner
- Name: Jan-Philipp Benecke
- Login: jpbede
- Kind: user
- Location: Near Leer, Germany
- Company: @cleverreach
- Website: https://bnck.me
- Twitter: janphilipp_bnck
- Repositories: 107
- Profile: https://github.com/jpbede
Email Deliverability & Software Engineer @cleverreach by day ☀️ // Core developer @home-assistant by night 🌑
GitHub Events
Total
- Release event: 2
- Watch event: 3
- Delete event: 261
- Issue comment event: 262
- Push event: 678
- Pull request review comment event: 2
- Pull request review event: 5
- Pull request event: 535
- Fork event: 1
- Create event: 257
Last Year
- Release event: 2
- Watch event: 3
- Delete event: 261
- Issue comment event: 262
- Push event: 678
- Pull request review comment event: 2
- Pull request review event: 5
- Pull request event: 535
- Fork event: 1
- Create event: 257
Committers
Last synced: 6 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| renovate[bot] | 2****] | 593 |
| Jan-Philipp Benecke | j****p@b****e | 56 |
| Viktor Andersson | 3****9 | 1 |
| Martin Weinelt | m****t | 1 |
| Marc Mueller | 3****p | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 6
- Total pull requests: 932
- Average time to close issues: about 3 hours
- Average time to close pull requests: about 24 hours
- Total issue authors: 1
- Total pull request authors: 6
- Average comments per issue: 0.67
- Average comments per pull request: 0.69
- Merged pull requests: 847
- Bot issues: 6
- Bot pull requests: 881
Past Year
- Issues: 3
- Pull requests: 590
- Average time to close issues: about 3 hours
- Average time to close pull requests: 1 day
- Issue authors: 1
- Pull request authors: 5
- Average comments per issue: 0.67
- Average comments per pull request: 0.78
- Merged pull requests: 537
- Bot issues: 3
- Bot pull requests: 579
Top Authors
Issue Authors
- renovate[bot] (6)
Pull Request Authors
- renovate[bot] (879)
- jpbede (45)
- mweinelt (2)
- cdce8p (2)
- dependabot[bot] (2)
- VIKTORVAV99 (2)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 2
-
Total downloads:
- pypi 44,403 last-month
- Total docker downloads: 14
-
Total dependent packages: 0
(may contain duplicates) -
Total dependent repositories: 0
(may contain duplicates) - Total versions: 15
- Total maintainers: 1
pypi.org: aioelectricitymaps
Async Python 3 wrapper for Electricity maps
- Documentation: https://aioelectricitymaps.readthedocs.io/
- License: MIT
-
Latest release: 1.1.1
published 6 months ago
Rankings
Maintainers (1)
pypi.org: aielectricitymaps
Async Python 3 wrapper for Electricity maps
- Homepage: https://github.com/jpbede/aioelectricitymaps
- Documentation: https://aielectricitymaps.readthedocs.io/
- License: MIT
-
Latest release: 0.1.0
published over 2 years ago
Rankings
Maintainers (1)
Dependencies
- actions/checkout v4 composite
- actions/setup-python v4 composite
- chartboost/ruff-action v1 composite
- codecov/codecov-action v3 composite
- actions/checkout v4 composite
- github/codeql-action/analyze v2 composite
- github/codeql-action/autobuild v2 composite
- github/codeql-action/init v2 composite
- abatilo/actions-poetry v2 composite
- actions/checkout v4 composite
- actions/setup-python v4 composite
- aiohttp 3.8.6
- aiosignal 1.3.1
- aresponses 2.1.6
- async-timeout 4.0.3
- attrs 23.1.0
- black 23.9.1
- cfgv 3.4.0
- charset-normalizer 3.3.0
- click 8.1.7
- colorama 0.4.6
- coverage 7.3.2
- dataclasses-json 0.6.1
- distlib 0.3.7
- exceptiongroup 1.1.3
- filelock 3.12.4
- frozenlist 1.4.0
- identify 2.5.30
- idna 3.4
- iniconfig 2.0.0
- marshmallow 3.20.1
- multidict 6.0.4
- mypy 1.6.0
- mypy-extensions 1.0.0
- nodeenv 1.8.0
- packaging 23.2
- pathspec 0.11.2
- platformdirs 3.11.0
- pluggy 1.3.0
- pre-commit 3.4.0
- pytest 7.4.2
- pytest-asyncio 0.21.1
- pytest-cov 4.1.0
- pyyaml 6.0.1
- ruff 0.0.292
- setuptools 68.2.2
- syrupy 4.5.0
- tomli 2.0.1
- typing-extensions 4.8.0
- typing-inspect 0.9.0
- virtualenv 20.24.5
- yarl 1.9.2
- aiohttp ^3.8.5
- dataclasses-json ^0.6.1
- python ^3.10