carbonmaps 0.10.6__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- carbonmaps-0.10.6/.gitignore +66 -0
- carbonmaps-0.10.6/.openapi-generator/FILES +95 -0
- carbonmaps-0.10.6/.openapi-generator/VERSION +1 -0
- carbonmaps-0.10.6/.openapi-generator-ignore +23 -0
- carbonmaps-0.10.6/PKG-INFO +152 -0
- carbonmaps-0.10.6/README.md +136 -0
- carbonmaps-0.10.6/carbonmaps/api/__init__.py +6 -0
- carbonmaps-0.10.6/carbonmaps/api/default_api.py +278 -0
- carbonmaps-0.10.6/carbonmaps/api/items_api.py +2128 -0
- carbonmaps-0.10.6/carbonmaps/api_client.py +804 -0
- carbonmaps-0.10.6/carbonmaps/api_response.py +21 -0
- carbonmaps-0.10.6/carbonmaps/configuration.py +587 -0
- carbonmaps-0.10.6/carbonmaps/exceptions.py +219 -0
- carbonmaps-0.10.6/carbonmaps/models/__init__.py +38 -0
- carbonmaps-0.10.6/carbonmaps/models/app_items_models_items_items_list_body_filters.py +93 -0
- carbonmaps-0.10.6/carbonmaps/models/component_public.py +92 -0
- carbonmaps-0.10.6/carbonmaps/models/component_ratio_type.py +37 -0
- carbonmaps-0.10.6/carbonmaps/models/detailed_item_list_public.py +205 -0
- carbonmaps-0.10.6/carbonmaps/models/detailed_item_public.py +205 -0
- carbonmaps-0.10.6/carbonmaps/models/detailed_items_public.py +105 -0
- carbonmaps-0.10.6/carbonmaps/models/facet_public.py +101 -0
- carbonmaps-0.10.6/carbonmaps/models/get_bulk_response.py +89 -0
- carbonmaps-0.10.6/carbonmaps/models/http_validation_error.py +95 -0
- carbonmaps-0.10.6/carbonmaps/models/item_create.py +132 -0
- carbonmaps-0.10.6/carbonmaps/models/item_map_public.py +91 -0
- carbonmaps-0.10.6/carbonmaps/models/item_nature.py +40 -0
- carbonmaps-0.10.6/carbonmaps/models/item_public.py +134 -0
- carbonmaps-0.10.6/carbonmaps/models/item_type.py +39 -0
- carbonmaps-0.10.6/carbonmaps/models/item_update.py +152 -0
- carbonmaps-0.10.6/carbonmaps/models/items_list_body.py +96 -0
- carbonmaps-0.10.6/carbonmaps/models/location_inner.py +138 -0
- carbonmaps-0.10.6/carbonmaps/models/packaging_public.py +90 -0
- carbonmaps-0.10.6/carbonmaps/models/supply_public.py +131 -0
- carbonmaps-0.10.6/carbonmaps/models/transport_public.py +102 -0
- carbonmaps-0.10.6/carbonmaps/models/transport_type.py +38 -0
- carbonmaps-0.10.6/carbonmaps/models/validation_error.py +108 -0
- carbonmaps-0.10.6/carbonmaps/py.typed +0 -0
- carbonmaps-0.10.6/carbonmaps/rest.py +263 -0
- carbonmaps-0.10.6/docs/AppItemsModelsItemsItemsListBodyFilters.md +29 -0
- carbonmaps-0.10.6/docs/ComponentPublic.md +31 -0
- carbonmaps-0.10.6/docs/ComponentRatioType.md +12 -0
- carbonmaps-0.10.6/docs/DefaultApi.md +70 -0
- carbonmaps-0.10.6/docs/DetailedItemListPublic.md +45 -0
- carbonmaps-0.10.6/docs/DetailedItemPublic.md +45 -0
- carbonmaps-0.10.6/docs/DetailedItemsPublic.md +31 -0
- carbonmaps-0.10.6/docs/FacetPublic.md +31 -0
- carbonmaps-0.10.6/docs/GetBulkResponse.md +30 -0
- carbonmaps-0.10.6/docs/HTTPValidationError.md +29 -0
- carbonmaps-0.10.6/docs/ItemCreate.md +39 -0
- carbonmaps-0.10.6/docs/ItemMapPublic.md +30 -0
- carbonmaps-0.10.6/docs/ItemNature.md +18 -0
- carbonmaps-0.10.6/docs/ItemPublic.md +40 -0
- carbonmaps-0.10.6/docs/ItemType.md +16 -0
- carbonmaps-0.10.6/docs/ItemUpdate.md +39 -0
- carbonmaps-0.10.6/docs/ItemsApi.md +579 -0
- carbonmaps-0.10.6/docs/ItemsListBody.md +29 -0
- carbonmaps-0.10.6/docs/LocationInner.md +28 -0
- carbonmaps-0.10.6/docs/PackagingPublic.md +30 -0
- carbonmaps-0.10.6/docs/SupplyPublic.md +37 -0
- carbonmaps-0.10.6/docs/TransportPublic.md +35 -0
- carbonmaps-0.10.6/docs/TransportType.md +14 -0
- carbonmaps-0.10.6/docs/ValidationError.md +33 -0
- carbonmaps-0.10.6/pyproject.toml +100 -0
- carbonmaps-0.10.6/requirements.txt +4 -0
- carbonmaps-0.10.6/setup.cfg +2 -0
- carbonmaps-0.10.6/setup.py +50 -0
- carbonmaps-0.10.6/test/__init__.py +0 -0
- carbonmaps-0.10.6/test/test_app_items_models_items_items_list_body_filters.py +53 -0
- carbonmaps-0.10.6/test/test_component_public.py +56 -0
- carbonmaps-0.10.6/test/test_component_ratio_type.py +33 -0
- carbonmaps-0.10.6/test/test_default_api.py +38 -0
- carbonmaps-0.10.6/test/test_detailed_item_list_public.py +104 -0
- carbonmaps-0.10.6/test/test_detailed_item_public.py +98 -0
- carbonmaps-0.10.6/test/test_detailed_items_public.py +155 -0
- carbonmaps-0.10.6/test/test_facet_public.py +54 -0
- carbonmaps-0.10.6/test/test_get_bulk_response.py +62 -0
- carbonmaps-0.10.6/test/test_http_validation_error.py +60 -0
- carbonmaps-0.10.6/test/test_item_create.py +66 -0
- carbonmaps-0.10.6/test/test_item_map_public.py +54 -0
- carbonmaps-0.10.6/test/test_item_nature.py +33 -0
- carbonmaps-0.10.6/test/test_item_public.py +68 -0
- carbonmaps-0.10.6/test/test_item_type.py +33 -0
- carbonmaps-0.10.6/test/test_item_update.py +63 -0
- carbonmaps-0.10.6/test/test_items_api.py +80 -0
- carbonmaps-0.10.6/test/test_items_list_body.py +54 -0
- carbonmaps-0.10.6/test/test_location_inner.py +50 -0
- carbonmaps-0.10.6/test/test_packaging_public.py +54 -0
- carbonmaps-0.10.6/test/test_supply_public.py +66 -0
- carbonmaps-0.10.6/test/test_transport_public.py +64 -0
- carbonmaps-0.10.6/test/test_transport_type.py +33 -0
- carbonmaps-0.10.6/test/test_validation_error.py +62 -0
- carbonmaps-0.10.6/test-requirements.txt +6 -0
- carbonmaps-0.10.6/tox.ini +9 -0
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# Byte-compiled / optimized / DLL files
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[cod]
|
|
4
|
+
*$py.class
|
|
5
|
+
|
|
6
|
+
# C extensions
|
|
7
|
+
*.so
|
|
8
|
+
|
|
9
|
+
# Distribution / packaging
|
|
10
|
+
.Python
|
|
11
|
+
env/
|
|
12
|
+
build/
|
|
13
|
+
develop-eggs/
|
|
14
|
+
dist/
|
|
15
|
+
downloads/
|
|
16
|
+
eggs/
|
|
17
|
+
.eggs/
|
|
18
|
+
lib/
|
|
19
|
+
lib64/
|
|
20
|
+
parts/
|
|
21
|
+
sdist/
|
|
22
|
+
var/
|
|
23
|
+
*.egg-info/
|
|
24
|
+
.installed.cfg
|
|
25
|
+
*.egg
|
|
26
|
+
|
|
27
|
+
# PyInstaller
|
|
28
|
+
# Usually these files are written by a python script from a template
|
|
29
|
+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
|
30
|
+
*.manifest
|
|
31
|
+
*.spec
|
|
32
|
+
|
|
33
|
+
# Installer logs
|
|
34
|
+
pip-log.txt
|
|
35
|
+
pip-delete-this-directory.txt
|
|
36
|
+
|
|
37
|
+
# Unit test / coverage reports
|
|
38
|
+
htmlcov/
|
|
39
|
+
.tox/
|
|
40
|
+
.coverage
|
|
41
|
+
.coverage.*
|
|
42
|
+
.cache
|
|
43
|
+
nosetests.xml
|
|
44
|
+
coverage.xml
|
|
45
|
+
*,cover
|
|
46
|
+
.hypothesis/
|
|
47
|
+
venv/
|
|
48
|
+
.venv/
|
|
49
|
+
.python-version
|
|
50
|
+
.pytest_cache
|
|
51
|
+
|
|
52
|
+
# Translations
|
|
53
|
+
*.mo
|
|
54
|
+
*.pot
|
|
55
|
+
|
|
56
|
+
# Django stuff:
|
|
57
|
+
*.log
|
|
58
|
+
|
|
59
|
+
# Sphinx documentation
|
|
60
|
+
docs/_build/
|
|
61
|
+
|
|
62
|
+
# PyBuilder
|
|
63
|
+
target/
|
|
64
|
+
|
|
65
|
+
# Ipython Notebook
|
|
66
|
+
.ipynb_checkpoints
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
.github/workflows/python.yml
|
|
2
|
+
.gitignore
|
|
3
|
+
.gitlab-ci.yml
|
|
4
|
+
.openapi-generator-ignore
|
|
5
|
+
.travis.yml
|
|
6
|
+
README.md
|
|
7
|
+
carbonmaps/__init__.py
|
|
8
|
+
carbonmaps/api/__init__.py
|
|
9
|
+
carbonmaps/api/default_api.py
|
|
10
|
+
carbonmaps/api/items_api.py
|
|
11
|
+
carbonmaps/api_client.py
|
|
12
|
+
carbonmaps/api_response.py
|
|
13
|
+
carbonmaps/configuration.py
|
|
14
|
+
carbonmaps/exceptions.py
|
|
15
|
+
carbonmaps/models/__init__.py
|
|
16
|
+
carbonmaps/models/app_items_models_items_items_list_body_filters.py
|
|
17
|
+
carbonmaps/models/component_public.py
|
|
18
|
+
carbonmaps/models/component_ratio_type.py
|
|
19
|
+
carbonmaps/models/detailed_item_list_public.py
|
|
20
|
+
carbonmaps/models/detailed_item_public.py
|
|
21
|
+
carbonmaps/models/detailed_items_public.py
|
|
22
|
+
carbonmaps/models/facet_public.py
|
|
23
|
+
carbonmaps/models/get_bulk_response.py
|
|
24
|
+
carbonmaps/models/http_validation_error.py
|
|
25
|
+
carbonmaps/models/item_create.py
|
|
26
|
+
carbonmaps/models/item_map_public.py
|
|
27
|
+
carbonmaps/models/item_nature.py
|
|
28
|
+
carbonmaps/models/item_public.py
|
|
29
|
+
carbonmaps/models/item_type.py
|
|
30
|
+
carbonmaps/models/item_update.py
|
|
31
|
+
carbonmaps/models/items_list_body.py
|
|
32
|
+
carbonmaps/models/location_inner.py
|
|
33
|
+
carbonmaps/models/packaging_public.py
|
|
34
|
+
carbonmaps/models/supply_public.py
|
|
35
|
+
carbonmaps/models/transport_public.py
|
|
36
|
+
carbonmaps/models/transport_type.py
|
|
37
|
+
carbonmaps/models/validation_error.py
|
|
38
|
+
carbonmaps/py.typed
|
|
39
|
+
carbonmaps/rest.py
|
|
40
|
+
docs/AppItemsModelsItemsItemsListBodyFilters.md
|
|
41
|
+
docs/ComponentPublic.md
|
|
42
|
+
docs/ComponentRatioType.md
|
|
43
|
+
docs/DefaultApi.md
|
|
44
|
+
docs/DetailedItemListPublic.md
|
|
45
|
+
docs/DetailedItemPublic.md
|
|
46
|
+
docs/DetailedItemsPublic.md
|
|
47
|
+
docs/FacetPublic.md
|
|
48
|
+
docs/GetBulkResponse.md
|
|
49
|
+
docs/HTTPValidationError.md
|
|
50
|
+
docs/ItemCreate.md
|
|
51
|
+
docs/ItemMapPublic.md
|
|
52
|
+
docs/ItemNature.md
|
|
53
|
+
docs/ItemPublic.md
|
|
54
|
+
docs/ItemType.md
|
|
55
|
+
docs/ItemUpdate.md
|
|
56
|
+
docs/ItemsApi.md
|
|
57
|
+
docs/ItemsListBody.md
|
|
58
|
+
docs/LocationInner.md
|
|
59
|
+
docs/PackagingPublic.md
|
|
60
|
+
docs/SupplyPublic.md
|
|
61
|
+
docs/TransportPublic.md
|
|
62
|
+
docs/TransportType.md
|
|
63
|
+
docs/ValidationError.md
|
|
64
|
+
git_push.sh
|
|
65
|
+
pyproject.toml
|
|
66
|
+
requirements.txt
|
|
67
|
+
setup.cfg
|
|
68
|
+
setup.py
|
|
69
|
+
test-requirements.txt
|
|
70
|
+
test/__init__.py
|
|
71
|
+
test/test_app_items_models_items_items_list_body_filters.py
|
|
72
|
+
test/test_component_public.py
|
|
73
|
+
test/test_component_ratio_type.py
|
|
74
|
+
test/test_default_api.py
|
|
75
|
+
test/test_detailed_item_list_public.py
|
|
76
|
+
test/test_detailed_item_public.py
|
|
77
|
+
test/test_detailed_items_public.py
|
|
78
|
+
test/test_facet_public.py
|
|
79
|
+
test/test_get_bulk_response.py
|
|
80
|
+
test/test_http_validation_error.py
|
|
81
|
+
test/test_item_create.py
|
|
82
|
+
test/test_item_map_public.py
|
|
83
|
+
test/test_item_nature.py
|
|
84
|
+
test/test_item_public.py
|
|
85
|
+
test/test_item_type.py
|
|
86
|
+
test/test_item_update.py
|
|
87
|
+
test/test_items_api.py
|
|
88
|
+
test/test_items_list_body.py
|
|
89
|
+
test/test_location_inner.py
|
|
90
|
+
test/test_packaging_public.py
|
|
91
|
+
test/test_supply_public.py
|
|
92
|
+
test/test_transport_public.py
|
|
93
|
+
test/test_transport_type.py
|
|
94
|
+
test/test_validation_error.py
|
|
95
|
+
tox.ini
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
7.19.0
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# OpenAPI Generator Ignore
|
|
2
|
+
# Generated by openapi-generator https://github.com/openapitools/openapi-generator
|
|
3
|
+
|
|
4
|
+
# Use this file to prevent files from being overwritten by the generator.
|
|
5
|
+
# The patterns follow closely to .gitignore or .dockerignore.
|
|
6
|
+
|
|
7
|
+
# As an example, the C# client generator defines ApiClient.cs.
|
|
8
|
+
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
|
|
9
|
+
#ApiClient.cs
|
|
10
|
+
|
|
11
|
+
# You can match any string of characters against a directory, file or extension with a single asterisk (*):
|
|
12
|
+
#foo/*/qux
|
|
13
|
+
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
|
|
14
|
+
|
|
15
|
+
# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
|
|
16
|
+
#foo/**/qux
|
|
17
|
+
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
|
|
18
|
+
|
|
19
|
+
# You can also negate patterns with an exclamation (!).
|
|
20
|
+
# For example, you can ignore all files in a docs folder with the file extension .md:
|
|
21
|
+
#docs/*.md
|
|
22
|
+
# Then explicitly reverse the ignore rule for a single file:
|
|
23
|
+
#!docs/README.md
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: carbonmaps
|
|
3
|
+
Version: 0.10.6
|
|
4
|
+
Summary: carbonmaps-api
|
|
5
|
+
Project-URL: Homepage, https://carbonmaps.io
|
|
6
|
+
Author-email: Carbon Maps <support@carbonmaps.io>
|
|
7
|
+
License-Expression: Apache-2.0
|
|
8
|
+
Keywords: OpenAPI,OpenAPI-Generator,carbonmaps-api
|
|
9
|
+
Requires-Python: >=3.9
|
|
10
|
+
Requires-Dist: lazy-imports<2,>=1
|
|
11
|
+
Requires-Dist: pydantic>=2
|
|
12
|
+
Requires-Dist: python-dateutil>=2.8.2
|
|
13
|
+
Requires-Dist: typing-extensions>=4.7.1
|
|
14
|
+
Requires-Dist: urllib3<3.0.0,>=2.1.0
|
|
15
|
+
Description-Content-Type: text/markdown
|
|
16
|
+
|
|
17
|
+
# carbonmaps
|
|
18
|
+
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
19
|
+
|
|
20
|
+
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project from the OpenAPI specification of the Carbon Maps API.
|
|
21
|
+
|
|
22
|
+
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.
|
|
23
|
+
|
|
24
|
+
- API version: 0.1.0
|
|
25
|
+
- Package version: 0.10.6
|
|
26
|
+
- Generator version: 7.19.0
|
|
27
|
+
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
|
|
28
|
+
|
|
29
|
+
## Requirements.
|
|
30
|
+
|
|
31
|
+
Python 3.9+
|
|
32
|
+
|
|
33
|
+
## Installation & Usage
|
|
34
|
+
### pip install
|
|
35
|
+
|
|
36
|
+
```sh
|
|
37
|
+
pip install carbonmaps
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Then import the package:
|
|
41
|
+
```python
|
|
42
|
+
import carbonmaps
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### Setuptools
|
|
46
|
+
|
|
47
|
+
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
|
|
48
|
+
|
|
49
|
+
```sh
|
|
50
|
+
python setup.py install --user
|
|
51
|
+
```
|
|
52
|
+
(or `sudo python setup.py install` to install the package for all users)
|
|
53
|
+
|
|
54
|
+
Then import the package:
|
|
55
|
+
```python
|
|
56
|
+
import carbonmaps
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### Tests
|
|
60
|
+
|
|
61
|
+
Execute `pytest` to run the tests.
|
|
62
|
+
|
|
63
|
+
## Getting Started
|
|
64
|
+
|
|
65
|
+
Please follow the [installation procedure](#installation--usage) and then run the following:
|
|
66
|
+
|
|
67
|
+
```python
|
|
68
|
+
|
|
69
|
+
import carbonmaps
|
|
70
|
+
from carbonmaps.rest import ApiException
|
|
71
|
+
from pprint import pprint
|
|
72
|
+
|
|
73
|
+
# Defining the host is optional and defaults to https://api.carbonmaps.io
|
|
74
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
75
|
+
configuration = carbonmaps.Configuration(
|
|
76
|
+
host = "https://api.carbonmaps.io"
|
|
77
|
+
)
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
# Enter a context with an instance of the API client
|
|
82
|
+
with carbonmaps.ApiClient(configuration) as api_client:
|
|
83
|
+
# Create an instance of the API class
|
|
84
|
+
api_instance = carbonmaps.DefaultApi(api_client)
|
|
85
|
+
|
|
86
|
+
try:
|
|
87
|
+
# Health Check
|
|
88
|
+
api_response = api_instance.health_check()
|
|
89
|
+
print("The response of DefaultApi->health_check:\n")
|
|
90
|
+
pprint(api_response)
|
|
91
|
+
except ApiException as e:
|
|
92
|
+
print("Exception when calling DefaultApi->health_check: %s\n" % e)
|
|
93
|
+
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
## Documentation for API Endpoints
|
|
97
|
+
|
|
98
|
+
All URIs are relative to *https://api.carbonmaps.io*
|
|
99
|
+
|
|
100
|
+
Class | Method | HTTP request | Description
|
|
101
|
+
------------ | ------------- | ------------- | -------------
|
|
102
|
+
*DefaultApi* | [**health_check**](docs/DefaultApi.md#health_check) | **GET** /health | Health Check
|
|
103
|
+
*ItemsApi* | [**create_item**](docs/ItemsApi.md#create_item) | **POST** /items/ | Create Item
|
|
104
|
+
*ItemsApi* | [**create_items_bulk**](docs/ItemsApi.md#create_items_bulk) | **POST** /items/bulk | Create Items Bulk
|
|
105
|
+
*ItemsApi* | [**delete_item**](docs/ItemsApi.md#delete_item) | **DELETE** /items/{item_id} | Delete Item
|
|
106
|
+
*ItemsApi* | [**delete_items_bulk**](docs/ItemsApi.md#delete_items_bulk) | **PUT** /items/delete/bulk | Delete Items Bulk
|
|
107
|
+
*ItemsApi* | [**get_item_detailed**](docs/ItemsApi.md#get_item_detailed) | **GET** /items/{item_id} | Get Item Detailed
|
|
108
|
+
*ItemsApi* | [**get_items**](docs/ItemsApi.md#get_items) | **POST** /items/list | Get Items
|
|
109
|
+
*ItemsApi* | [**update_item**](docs/ItemsApi.md#update_item) | **PUT** /items/{item_id} | Update Item
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
## Documentation For Models
|
|
113
|
+
|
|
114
|
+
- [AppItemsModelsItemsItemsListBodyFilters](docs/AppItemsModelsItemsItemsListBodyFilters.md)
|
|
115
|
+
- [ComponentPublic](docs/ComponentPublic.md)
|
|
116
|
+
- [ComponentRatioType](docs/ComponentRatioType.md)
|
|
117
|
+
- [DetailedItemListPublic](docs/DetailedItemListPublic.md)
|
|
118
|
+
- [DetailedItemPublic](docs/DetailedItemPublic.md)
|
|
119
|
+
- [DetailedItemsPublic](docs/DetailedItemsPublic.md)
|
|
120
|
+
- [FacetPublic](docs/FacetPublic.md)
|
|
121
|
+
- [GetBulkResponse](docs/GetBulkResponse.md)
|
|
122
|
+
- [HTTPValidationError](docs/HTTPValidationError.md)
|
|
123
|
+
- [ItemCreate](docs/ItemCreate.md)
|
|
124
|
+
- [ItemMapPublic](docs/ItemMapPublic.md)
|
|
125
|
+
- [ItemNature](docs/ItemNature.md)
|
|
126
|
+
- [ItemPublic](docs/ItemPublic.md)
|
|
127
|
+
- [ItemType](docs/ItemType.md)
|
|
128
|
+
- [ItemUpdate](docs/ItemUpdate.md)
|
|
129
|
+
- [ItemsListBody](docs/ItemsListBody.md)
|
|
130
|
+
- [LocationInner](docs/LocationInner.md)
|
|
131
|
+
- [PackagingPublic](docs/PackagingPublic.md)
|
|
132
|
+
- [SupplyPublic](docs/SupplyPublic.md)
|
|
133
|
+
- [TransportPublic](docs/TransportPublic.md)
|
|
134
|
+
- [TransportType](docs/TransportType.md)
|
|
135
|
+
- [ValidationError](docs/ValidationError.md)
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
<a id="documentation-for-authorization"></a>
|
|
139
|
+
## Documentation For Authorization
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
Authentication schemes defined for the API:
|
|
143
|
+
<a id="HTTPBearer"></a>
|
|
144
|
+
### HTTPBearer
|
|
145
|
+
|
|
146
|
+
- **Type**: Bearer authentication
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
## Author
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
# carbonmaps
|
|
2
|
+
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
3
|
+
|
|
4
|
+
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project from the OpenAPI specification of the Carbon Maps API.
|
|
5
|
+
|
|
6
|
+
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.
|
|
7
|
+
|
|
8
|
+
- API version: 0.1.0
|
|
9
|
+
- Package version: 0.10.6
|
|
10
|
+
- Generator version: 7.19.0
|
|
11
|
+
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
|
|
12
|
+
|
|
13
|
+
## Requirements.
|
|
14
|
+
|
|
15
|
+
Python 3.9+
|
|
16
|
+
|
|
17
|
+
## Installation & Usage
|
|
18
|
+
### pip install
|
|
19
|
+
|
|
20
|
+
```sh
|
|
21
|
+
pip install carbonmaps
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Then import the package:
|
|
25
|
+
```python
|
|
26
|
+
import carbonmaps
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
### Setuptools
|
|
30
|
+
|
|
31
|
+
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
|
|
32
|
+
|
|
33
|
+
```sh
|
|
34
|
+
python setup.py install --user
|
|
35
|
+
```
|
|
36
|
+
(or `sudo python setup.py install` to install the package for all users)
|
|
37
|
+
|
|
38
|
+
Then import the package:
|
|
39
|
+
```python
|
|
40
|
+
import carbonmaps
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### Tests
|
|
44
|
+
|
|
45
|
+
Execute `pytest` to run the tests.
|
|
46
|
+
|
|
47
|
+
## Getting Started
|
|
48
|
+
|
|
49
|
+
Please follow the [installation procedure](#installation--usage) and then run the following:
|
|
50
|
+
|
|
51
|
+
```python
|
|
52
|
+
|
|
53
|
+
import carbonmaps
|
|
54
|
+
from carbonmaps.rest import ApiException
|
|
55
|
+
from pprint import pprint
|
|
56
|
+
|
|
57
|
+
# Defining the host is optional and defaults to https://api.carbonmaps.io
|
|
58
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
59
|
+
configuration = carbonmaps.Configuration(
|
|
60
|
+
host = "https://api.carbonmaps.io"
|
|
61
|
+
)
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
# Enter a context with an instance of the API client
|
|
66
|
+
with carbonmaps.ApiClient(configuration) as api_client:
|
|
67
|
+
# Create an instance of the API class
|
|
68
|
+
api_instance = carbonmaps.DefaultApi(api_client)
|
|
69
|
+
|
|
70
|
+
try:
|
|
71
|
+
# Health Check
|
|
72
|
+
api_response = api_instance.health_check()
|
|
73
|
+
print("The response of DefaultApi->health_check:\n")
|
|
74
|
+
pprint(api_response)
|
|
75
|
+
except ApiException as e:
|
|
76
|
+
print("Exception when calling DefaultApi->health_check: %s\n" % e)
|
|
77
|
+
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
## Documentation for API Endpoints
|
|
81
|
+
|
|
82
|
+
All URIs are relative to *https://api.carbonmaps.io*
|
|
83
|
+
|
|
84
|
+
Class | Method | HTTP request | Description
|
|
85
|
+
------------ | ------------- | ------------- | -------------
|
|
86
|
+
*DefaultApi* | [**health_check**](docs/DefaultApi.md#health_check) | **GET** /health | Health Check
|
|
87
|
+
*ItemsApi* | [**create_item**](docs/ItemsApi.md#create_item) | **POST** /items/ | Create Item
|
|
88
|
+
*ItemsApi* | [**create_items_bulk**](docs/ItemsApi.md#create_items_bulk) | **POST** /items/bulk | Create Items Bulk
|
|
89
|
+
*ItemsApi* | [**delete_item**](docs/ItemsApi.md#delete_item) | **DELETE** /items/{item_id} | Delete Item
|
|
90
|
+
*ItemsApi* | [**delete_items_bulk**](docs/ItemsApi.md#delete_items_bulk) | **PUT** /items/delete/bulk | Delete Items Bulk
|
|
91
|
+
*ItemsApi* | [**get_item_detailed**](docs/ItemsApi.md#get_item_detailed) | **GET** /items/{item_id} | Get Item Detailed
|
|
92
|
+
*ItemsApi* | [**get_items**](docs/ItemsApi.md#get_items) | **POST** /items/list | Get Items
|
|
93
|
+
*ItemsApi* | [**update_item**](docs/ItemsApi.md#update_item) | **PUT** /items/{item_id} | Update Item
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
## Documentation For Models
|
|
97
|
+
|
|
98
|
+
- [AppItemsModelsItemsItemsListBodyFilters](docs/AppItemsModelsItemsItemsListBodyFilters.md)
|
|
99
|
+
- [ComponentPublic](docs/ComponentPublic.md)
|
|
100
|
+
- [ComponentRatioType](docs/ComponentRatioType.md)
|
|
101
|
+
- [DetailedItemListPublic](docs/DetailedItemListPublic.md)
|
|
102
|
+
- [DetailedItemPublic](docs/DetailedItemPublic.md)
|
|
103
|
+
- [DetailedItemsPublic](docs/DetailedItemsPublic.md)
|
|
104
|
+
- [FacetPublic](docs/FacetPublic.md)
|
|
105
|
+
- [GetBulkResponse](docs/GetBulkResponse.md)
|
|
106
|
+
- [HTTPValidationError](docs/HTTPValidationError.md)
|
|
107
|
+
- [ItemCreate](docs/ItemCreate.md)
|
|
108
|
+
- [ItemMapPublic](docs/ItemMapPublic.md)
|
|
109
|
+
- [ItemNature](docs/ItemNature.md)
|
|
110
|
+
- [ItemPublic](docs/ItemPublic.md)
|
|
111
|
+
- [ItemType](docs/ItemType.md)
|
|
112
|
+
- [ItemUpdate](docs/ItemUpdate.md)
|
|
113
|
+
- [ItemsListBody](docs/ItemsListBody.md)
|
|
114
|
+
- [LocationInner](docs/LocationInner.md)
|
|
115
|
+
- [PackagingPublic](docs/PackagingPublic.md)
|
|
116
|
+
- [SupplyPublic](docs/SupplyPublic.md)
|
|
117
|
+
- [TransportPublic](docs/TransportPublic.md)
|
|
118
|
+
- [TransportType](docs/TransportType.md)
|
|
119
|
+
- [ValidationError](docs/ValidationError.md)
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
<a id="documentation-for-authorization"></a>
|
|
123
|
+
## Documentation For Authorization
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
Authentication schemes defined for the API:
|
|
127
|
+
<a id="HTTPBearer"></a>
|
|
128
|
+
### HTTPBearer
|
|
129
|
+
|
|
130
|
+
- **Type**: Bearer authentication
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
## Author
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|