Tracarbon is a Python library that tracks your device's energy consumption and calculates your carbon emissions.
Project description
📌 Overview
Tracarbon is a Python library that tracks your device's energy consumption and calculates your carbon emissions.
It detects your location and your device automatically before starting to export measurements to an exporter. It could be used as a CLI with already defined metrics or programmatically with the API by defining the metrics that you want to have.
Read more in this article.
📦 Where to get it
# Install Tracarbon
pip install tracarbon
# Install one or more exporters from the list
pip install 'tracarbon[datadog,prometheus,kubernetes]'
🔌 Devices: energy consumption
| Devices | Description |
|---|---|
| Mac | ✅ Global energy consumption of your Mac (must be plugged into a wall adapter). |
| Linux | ⚠️ Only with RAPL. See #1. It works with containers on Kubernetes using the Metric API if available. |
| Windows | ❌ Not yet implemented. See #184. |
| Cloud Provider | Description |
|---|---|
| AWS | ✅ Use the hardware's usage with the EC2 instances carbon emissions datasets of cloud-carbon-coefficients. |
| GCP | ❌ Not yet implemented. |
| Azure | ❌ Not yet implemented. |
📡 Exporters
| Exporter | Description |
|---|---|
| Stdout | Print the metrics in Stdout. |
| JSON | Write the metrics in a JSON file. |
| Prometheus | Send the metrics to Prometheus. |
| Datadog | Send the metrics to Datadog. |
🗺️ Locations
| Location | Description | Source |
|---|---|---|
| Worldwide | Get the latest co2g/kwh in near real-time using the CO2Signal or ElectricityMaps APIs. See here for the list of available zones. | CO2Signal API or ElectricityMaps |
| Europe | Static file created from the European Environment Agency Emission for the co2g/kwh in European countries. | EEA website |
| AWS | Static file of the AWS Grid emissions factors. | cloud-carbon-coefficients |
⚙️ Configuration
The environment variables can be set from an environment file .env.
| Parameter | Description |
|---|---|
| TRACARBON_CO2SIGNAL_API_KEY | The api key received from CO2Signal or ElectricityMaps. |
| TRACARBON_CO2SIGNAL_URL | The url of CO2Signal is the default endpoint to retrieve the last known state of the zone, but it could be changed to ElectricityMaps. |
| TRACARBON_METRIC_PREFIX_NAME | The prefix to use in all the metrics name. |
| TRACARBON_INTERVAL_IN_SECONDS | The interval in seconds to wait between the metrics evaluation. |
| TRACARBON_LOG_LEVEL | The level to use for displaying the logs. |
🔎 Usage
Request your API key
- Go to CO2Signal and get your free API key for non-commercial use, or go to ElectricityMaps for commercial use.
- This API is used to retrieve the last known carbon intensity (in gCO2eq/kWh) of electricity consumed in your location.
- Set your API key in the environment variables, in the
.envfile or directly in the configuration. - If you would like to start without an API key, it's possible, the carbon intensity will be loaded statistically from a file.
- Launch Tracarbon 🚀
Command Line
tracarbon run
API
from tracarbon import TracarbonBuilder, TracarbonConfiguration
configuration = TracarbonConfiguration() # Your configuration
tracarbon = TracarbonBuilder(configuration=configuration).build()
tracarbon.start()
# Your code
tracarbon.stop()
with tracarbon:
# Your code
report = tracarbon.report() # Get the report
💻 Development
Local: using Poetry
make init
make test-unit
🛡️ Licence
📚 Documentation
The documentation is hosted here: https://fvaleye.github.io/tracarbon/documentation
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
tracarbon-0.7.3.tar.gz
(48.9 kB
view details)
Built Distribution
tracarbon-0.7.3-py3-none-any.whl
(55.4 kB
view details)
File details
Details for the file tracarbon-0.7.3.tar.gz.
File metadata
- Download URL: tracarbon-0.7.3.tar.gz
- Upload date:
- Size: 48.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.4 CPython/3.8.18 Linux/6.5.0-1025-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8dcfbe94049fa0c4f16052ef72ef20c5165a307eda54c7fc65965045d50a9a7a |
|
| MD5 | bb6976d8308319916b081a28cc7b97e7 |
|
| BLAKE2b-256 | 59e09a03669dfca7251c3b7f233ab80a46edd544941de3a09a27547d1334ba3b |
File details
Details for the file tracarbon-0.7.3-py3-none-any.whl.
File metadata
- Download URL: tracarbon-0.7.3-py3-none-any.whl
- Upload date:
- Size: 55.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.4 CPython/3.8.18 Linux/6.5.0-1025-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 92a5f8cc85ffc98dafc731d53cb90088513e3175aecebbc8f30a46ea9c55672b |
|
| MD5 | 2a9ffea3a4daa53ee71e9e88ed1688a4 |
|
| BLAKE2b-256 | bbf311f8778642999e67741070d59dcf15eb0a2111c713170a776380514738db |
