Skip to main content

Official Python wrapper for the DitchCarbon API

Project description



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.

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

ditchcarbon-python-0.1.2.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

ditchcarbon_python-0.1.2-py3-none-any.whl (7.6 kB view details)

Uploaded Python 3

File details

Details for the file ditchcarbon-python-0.1.2.tar.gz.

File metadata

  • Download URL: ditchcarbon-python-0.1.2.tar.gz
  • Upload date:
  • Size: 6.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.2

File hashes

Hashes for ditchcarbon-python-0.1.2.tar.gz
Algorithm Hash digest
SHA256 171d3eaf9abdbc0c94fb178dd26ad27a90691202f78ea565f2964d65fb28f2ed
MD5 eab6edb89e80ecf8c997ff4f7f9f1933
BLAKE2b-256 6f499068563b3a3bb802c01700caf35fba4439a828581193e04c5f2aaeae850e

See more details on using hashes here.

File details

Details for the file ditchcarbon_python-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for ditchcarbon_python-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f6bba2e8c325dacedc51ffff00a14d66b88ca4217e3d41821abd7fd796da7516
MD5 8b692e8c5a5841f422466ceb0074bf38
BLAKE2b-256 fcea2a36b31ba762e9d66fb7ee474cbe7f084e2e398a2e3b5448760ec7262725

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