Metadata-Version: 2.4
Name: carbonmaps
Version: 0.10.6
Summary: carbonmaps-api
Project-URL: Homepage, https://carbonmaps.io
Author-email: Carbon Maps <support@carbonmaps.io>
License-Expression: Apache-2.0
Keywords: OpenAPI,OpenAPI-Generator,carbonmaps-api
Requires-Python: >=3.9
Requires-Dist: lazy-imports<2,>=1
Requires-Dist: pydantic>=2
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: typing-extensions>=4.7.1
Requires-Dist: urllib3<3.0.0,>=2.1.0
Description-Content-Type: text/markdown

# carbonmaps
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project from the OpenAPI specification of the Carbon Maps API.

The generated client code is licensed under Apache-2.0. Use of the Carbon Maps API itself requires credentials issued under a commercial agreement with Carbon Maps: this package is of no use without them.

- API version: 0.1.0
- Package version: 0.10.6
- Generator version: 7.19.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.9+

## Installation & Usage
### pip install

```sh
pip install carbonmaps
```

Then import the package:
```python
import carbonmaps
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import carbonmaps
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import carbonmaps
from carbonmaps.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.carbonmaps.io
# See configuration.py for a list of all supported configuration parameters.
configuration = carbonmaps.Configuration(
    host = "https://api.carbonmaps.io"
)



# Enter a context with an instance of the API client
with carbonmaps.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = carbonmaps.DefaultApi(api_client)

    try:
        # Health Check
        api_response = api_instance.health_check()
        print("The response of DefaultApi->health_check:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DefaultApi->health_check: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://api.carbonmaps.io*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**health_check**](docs/DefaultApi.md#health_check) | **GET** /health | Health Check
*ItemsApi* | [**create_item**](docs/ItemsApi.md#create_item) | **POST** /items/ | Create Item
*ItemsApi* | [**create_items_bulk**](docs/ItemsApi.md#create_items_bulk) | **POST** /items/bulk | Create Items Bulk
*ItemsApi* | [**delete_item**](docs/ItemsApi.md#delete_item) | **DELETE** /items/{item_id} | Delete Item
*ItemsApi* | [**delete_items_bulk**](docs/ItemsApi.md#delete_items_bulk) | **PUT** /items/delete/bulk | Delete Items Bulk
*ItemsApi* | [**get_item_detailed**](docs/ItemsApi.md#get_item_detailed) | **GET** /items/{item_id} | Get Item Detailed
*ItemsApi* | [**get_items**](docs/ItemsApi.md#get_items) | **POST** /items/list | Get Items
*ItemsApi* | [**update_item**](docs/ItemsApi.md#update_item) | **PUT** /items/{item_id} | Update Item


## Documentation For Models

 - [AppItemsModelsItemsItemsListBodyFilters](docs/AppItemsModelsItemsItemsListBodyFilters.md)
 - [ComponentPublic](docs/ComponentPublic.md)
 - [ComponentRatioType](docs/ComponentRatioType.md)
 - [DetailedItemListPublic](docs/DetailedItemListPublic.md)
 - [DetailedItemPublic](docs/DetailedItemPublic.md)
 - [DetailedItemsPublic](docs/DetailedItemsPublic.md)
 - [FacetPublic](docs/FacetPublic.md)
 - [GetBulkResponse](docs/GetBulkResponse.md)
 - [HTTPValidationError](docs/HTTPValidationError.md)
 - [ItemCreate](docs/ItemCreate.md)
 - [ItemMapPublic](docs/ItemMapPublic.md)
 - [ItemNature](docs/ItemNature.md)
 - [ItemPublic](docs/ItemPublic.md)
 - [ItemType](docs/ItemType.md)
 - [ItemUpdate](docs/ItemUpdate.md)
 - [ItemsListBody](docs/ItemsListBody.md)
 - [LocationInner](docs/LocationInner.md)
 - [PackagingPublic](docs/PackagingPublic.md)
 - [SupplyPublic](docs/SupplyPublic.md)
 - [TransportPublic](docs/TransportPublic.md)
 - [TransportType](docs/TransportType.md)
 - [ValidationError](docs/ValidationError.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="HTTPBearer"></a>
### HTTPBearer

- **Type**: Bearer authentication


## Author



