Skip to content

ditchcarbon/ditchcarbon-python

Repository files navigation



ditchcarbon-python

PyPI PyPI - Downloads PyPI - License PyPI - Python Version GitHub code size in bytes Code style

What is it?

ditchcarbon-python is the official Python wrapper for the DitchCarbon API. DitchCarbon calculates the carbon impact of almost anything using a combination of GHG protocol approved calculations and an unparalleled database of company and product disclosures.

Where to get it?

You can install the library via PyPI (hosted here):

pip3 install ditchcarbon-python

The source code is currently hosted on GitHub, here.

How to use it?

First, import and initialise the library with your API token:

from ditchcarbon_python import Client
ditchcarbon = Client(token="YOUR_TOKEN")

Then, use it:

# Activities
ditchcarbon.activities.retrieve(1)
ditchcarbon.activities.retrieve_many(**params)
ditchcarbon.activities.retrieve_assessment(1, **params)
ditchcarbon.activities.retrieve_categories(**params)

# Categories
ditchcarbon.categories.search(**params)

# Expenses
ditchcarbon.expenses.calculate_emissions(**params)

# Products
ditchcarbon.products.calculate_emissions(**params)

# Servers
ditchcarbon.servers.find(**params)
ditchcarbon.servers.retrieve(1)
ditchcarbon.servers.calculate_emissions(1, **params)

# Suppliers
ditchcarbon.suppliers.calculate_emissions(**params)

Documentation and Help

View our API reference here. For usage questions, feel free to contact us here.