Metadata-Version: 2.1
Name: DitchCarbon
Version: 0.0.5
Summary: Introducing "DitchCarbon", an open-source Python package that allows users to easily call the DitchCarbon API using HTTP requests.
Author-email: Luke Cummins <lc2232@bath.ac.uk>, Alex Dawkins <asd60@bath.ac.uk>, Joe Downard <jhd35@bath.ac.uk>, Sergios Gavriilidis <sg2295@bath.ac.uk>
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE

# DitchCarbon Python Package

An open-source Python package that allows users to easily call the DitchCarbon API (v1.0) with type hints etc from within Python.

DitchCarbon is an API that provides information on carbon emissions of different energy sources across the globe. With DitchPy, users can easily retrieve information about the carbon emissions of different energy sources and use it in their own projects.

This package is built on top of the requests library and provides a simple interface for making HTTP requests to the DitchCarbon API. The package includes a set of functions that allow users to retrieve data for specific countries, energy sources, and time periods.

To get started, users can simply install it using pip:

```
pip install DitchCarbon
```

## Usage

Create an instance of the DitchCarbonClient:

```
carbon_client = DitchCarbonClient(api_key=API_KEY)
```

Then call one of the DitchCarbonAPIs endpoints:

```
carbon_client.get_supplier('Nestle', currency='GBP'))
```


