openepd 2.0.0__tar.gz → 3.0.0__tar.gz

openepd-2.0.0/README.md → openepd-3.0.0/PKG-INFO

@@ -1,3 +1,28 @@
+Metadata-Version: 2.1
+Name: openepd
+Version: 3.0.0
+Summary: Python library to work with OpenEPD format
+Home-page: https://github.com/cchangelabs/openepd
+License: Apache-2.0
+Author: C-Change Labs
+Author-email: support@c-change-labs.com
+Maintainer: C-Change Labs
+Maintainer-email: open-source@c-change-labs.com
+Requires-Python: >=3.11,<4.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Provides-Extra: api-client
+Requires-Dist: email-validator (>=1.3.1)
+Requires-Dist: pydantic (>=1.10,<3.0)
+Requires-Dist: requests (>=2.0) ; extra == "api-client"
+Project-URL: Repository, https://github.com/cchangelabs/openepd
+Description-Content-Type: text/markdown
+
 # Python Library to work with OpenEPD format
 
 <p align="center">
@@ -34,18 +59,47 @@ documenting supply-chain specific data.
 
 ## Usage
 
+## Usage
+
 **❗ ATTENTION**: Pick the right version. The cornerstone of this library models package representing openEPD models. 
 Models are defined with Pydantic library which is a dependency for openepd package. If you use Pydantic in your project
 carefully pick the version:
 
-* Use version below `1.0.0` if your project uses Pydantic version below `2.0.0`
-* Use version `1.0.0` or higher if your project uses Pydantic version `2.0.0` or above
+* Use version **below** `2.0.0` if your project uses Pydantic version below `2.0.0`
+* Use version `2.x.x` or higher if your project uses Pydantic version `2.0.0` or above
 
 ### Models
 
 The library provides the Pydantic models for all the OpenEPD entities. The models are available in the `openepd.models`
 module. For mode details on the usage please refer to Pydantic documentation.
 
+### API Client
+
+The library provides the API client to work with the OpenEPD API. The client is available in the `openepd.client` module.
+Currently, the only available implementation is based on synchronous [requests]() library. Client provides the following
+features:
+* Error handling - depending on HTTP status code the client raises different exceptions allowing to handle errors
+  in a more granular way.
+* Throttling - the client is able to throttle the requests to the API to avoid hitting the rate limits.
+* Retry - the client is able to retry the requests in case of the network errors.
+
+#### API Client Usage
+
+The following example illustrates the usage of the API client:
+
+```python
+from openepd.api.sync_client import OpenEpdApiClientSync
+
+# Setup the client
+api_client = OpenEpdApiClientSync(
+    "https://openepd.buildingtransparency.org/api",
+    "<Your API Token>",
+)
+
+# Use API, e.g. get EPD by ID
+epd = api_client.epds.get_by_openxpd_uuid("ec3b9j5t")
+```
+
 ### Bundle
 
 Bundle is a format which allows to bundle multiple openEPD objects together (it might be EPDs, PCRs, Orgs + any
@@ -96,3 +150,4 @@ This library has been written and maintained by [C-Change Labs](https://c-change
 # License
 
 This library is licensed under [Apache 2](/LICENSE). This means you are free to use it in commercial projects.
+

openepd-2.0.0/PKG-INFO → openepd-3.0.0/README.md

@@ -1,26 +1,3 @@
-Metadata-Version: 2.1
-Name: openepd
-Version: 2.0.0
-Summary: Python library to work with OpenEPD format
-Home-page: https://github.com/cchangelabs/openepd
-License: Apache-2.0
-Author: C-Change Labs
-Author-email: support@c-change-labs.com
-Maintainer: C-Change Labs
-Maintainer-email: open-source@c-change-labs.com
-Requires-Python: >=3.11,<4.0
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Dist: email-validator (>=1.3.0)
-Requires-Dist: pydantic (>=2.0,<3.0)
-Project-URL: Repository, https://github.com/cchangelabs/openepd
-Description-Content-Type: text/markdown
-
 # Python Library to work with OpenEPD format
 
 <p align="center">
@@ -57,18 +34,47 @@ documenting supply-chain specific data.
 
 ## Usage
 
+## Usage
+
 **❗ ATTENTION**: Pick the right version. The cornerstone of this library models package representing openEPD models. 
 Models are defined with Pydantic library which is a dependency for openepd package. If you use Pydantic in your project
 carefully pick the version:
 
-* Use version below `1.0.0` if your project uses Pydantic version below `2.0.0`
-* Use version `1.0.0` or higher if your project uses Pydantic version `2.0.0` or above
+* Use version **below** `2.0.0` if your project uses Pydantic version below `2.0.0`
+* Use version `2.x.x` or higher if your project uses Pydantic version `2.0.0` or above
 
 ### Models
 
 The library provides the Pydantic models for all the OpenEPD entities. The models are available in the `openepd.models`
 module. For mode details on the usage please refer to Pydantic documentation.
 
+### API Client
+
+The library provides the API client to work with the OpenEPD API. The client is available in the `openepd.client` module.
+Currently, the only available implementation is based on synchronous [requests]() library. Client provides the following
+features:
+* Error handling - depending on HTTP status code the client raises different exceptions allowing to handle errors
+  in a more granular way.
+* Throttling - the client is able to throttle the requests to the API to avoid hitting the rate limits.
+* Retry - the client is able to retry the requests in case of the network errors.
+
+#### API Client Usage
+
+The following example illustrates the usage of the API client:
+
+```python
+from openepd.api.sync_client import OpenEpdApiClientSync
+
+# Setup the client
+api_client = OpenEpdApiClientSync(
+    "https://openepd.buildingtransparency.org/api",
+    "<Your API Token>",
+)
+
+# Use API, e.g. get EPD by ID
+epd = api_client.epds.get_by_openxpd_uuid("ec3b9j5t")
+```
+
 ### Bundle
 
 Bundle is a format which allows to bundle multiple openEPD objects together (it might be EPDs, PCRs, Orgs + any
@@ -119,4 +125,3 @@ This library has been written and maintained by [C-Change Labs](https://c-change
 # License
 
 This library is licensed under [Apache 2](/LICENSE). This means you are free to use it in commercial projects.
-

{openepd-2.0.0 → openepd-3.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openepd"
-version = "2.0.0"
+version = "3.0.0"
 license = "Apache-2.0"
 description = "Python library to work with OpenEPD format"
 authors = ["C-Change Labs <support@c-change-labs.com>"]
@@ -21,8 +21,9 @@ exclude = ["**/test_*.py", "**/tests/**"]
 
 [tool.poetry.dependencies]
 python = "^3.11"
-pydantic = ">=2.0,<3.0"
-email-validator = ">=1.3.0"
+pydantic = ">=1.10,<3.0"
+email-validator = ">=1.3.1"
+requests = { version = ">=2.0", optional = true }
 
 # Optional dependencies
 # lxml = { version = "~=4.9.2", optional = true }
@@ -45,23 +46,23 @@ flake8-docstrings = "~=1.7.0"
 isort = "~=5.11"
 mypy = ">=1.0.1"
 pre-commit = "~=2.19"
-commitizen = "~=2.42.1"
+commitizen = "~=3.16.0"
 
 # Type checking
 types-dateparser = ">=1.1.3"
 types-deprecated = ">=1.2.9"
+types-requests = ">=2.0"
 
 [tool.poetry.extras]
-#xml = ["lxml"]
+api_client = ["requests"]
 
 
 [tool.commitizen]
-version = "2.0.0"
+version_provider = "poetry"
 bump_version = "bump: version $current_version → $new_version"
 update_changelog_on_bump = true
 pre_bump_hooks = []
 version_files = [
-    "pyproject.toml",
     "src/openepd/__version__.py",
 ]
 
@@ -122,6 +123,7 @@ warn_return_any = false
 disallow_any_generics = false
 pretty = true
 mypy_path = "$MYPY_CONFIG_FILE_DIR/stubs"
+plugins = ["pydantic.mypy"]
 exclude = ["test_.*\\.py$", ]
 
 [[tool.mypy.overrides]]

{openepd-2.0.0 → openepd-3.0.0}/src/openepd/__init__.py

@@ -1,5 +1,5 @@
 #
-#  Copyright 2023 by C Change Labs Inc. www.c-change-labs.com
+#  Copyright 2024 by C Change Labs Inc. www.c-change-labs.com
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.

{openepd-2.0.0 → openepd-3.0.0}/src/openepd/__version__.py

@@ -1,5 +1,5 @@
 #
-#  Copyright 2023 by C Change Labs Inc. www.c-change-labs.com
+#  Copyright 2024 by C Change Labs Inc. www.c-change-labs.com
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -17,4 +17,4 @@
 #  Charles Pankow Foundation, Microsoft Sustainability Fund, Interface, MKA Foundation, and others.
 #  Find out more at www.BuildingTransparency.org
 #
-VERSION = "2.0.0"
+VERSION = "3.0.0"

{openepd-2.0.0/src/openepd/bundle → openepd-3.0.0/src/openepd/api}/__init__.py

@@ -1,5 +1,5 @@
 #
-#  Copyright 2023 by C Change Labs Inc. www.c-change-labs.com
+#  Copyright 2024 by C Change Labs Inc. www.c-change-labs.com
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.