ocpplab 0.1.1__tar.gz

ocpplab-0.1.1/PKG-INFO

@@ -0,0 +1,262 @@
+Metadata-Version: 2.1
+Name: ocpplab
+Version: 0.1.1
+Summary: 
+Keywords: ev,ocpp,sdk,api,charging
+Requires-Python: >=3.10,<4.0
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: OS Independent
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Provides-Extra: aiohttp
+Requires-Dist: aiohttp (>=3.10.0,<4) ; extra == "aiohttp"
+Requires-Dist: httpx (>=0.21.2)
+Requires-Dist: httpx-aiohttp (==0.1.8) ; extra == "aiohttp"
+Requires-Dist: pydantic (>=1.9.2)
+Requires-Dist: pydantic-core (>=2.18.2,<2.44.0)
+Requires-Dist: typing_extensions (>=4.0.0)
+Project-URL: Documentation, https://github.com/ev-cloudx/ocpplab-sdk
+Project-URL: Homepage, https://github.com/ev-cloudx/ocpplab-sdk
+Project-URL: Repository, https://github.com/ev-cloudx/ocpplab-sdk
+Description-Content-Type: text/markdown
+
+# Ocpplab Python Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fev-cloudx%2Focpplab-sdk)
+[![pypi](https://img.shields.io/pypi/v/ocpplab)](https://pypi.python.org/pypi/ocpplab)
+
+The Ocpplab Python library provides convenient access to the Ocpplab APIs from Python.
+
+## Table of Contents
+
+- [Run](#run)
+- [Contract](#contract)
+- [Client Generation](#client-generation)
+- [Notes](#notes)
+- [Seed Scripts](#seed-scripts)
+- [Installation](#installation)
+- [Reference](#reference)
+- [Usage](#usage)
+- [Async Client](#async-client)
+- [Exception Handling](#exception-handling)
+- [Advanced](#advanced)
+  - [Access Raw Response Data](#access-raw-response-data)
+  - [Retries](#retries)
+  - [Timeouts](#timeouts)
+  - [Custom Client](#custom-client)
+- [Contributing](#contributing)
+
+## Run
+
+Start the API locally with:
+
+```bash
+uvicorn src.main:app --reload --host 0.0.0.0 --port 8000
+```
+
+## Contract
+
+- Runtime OpenAPI JSON: `/openapi.json`
+- Checked-in spec: [`openapi.yaml`](/Users/yacine-elazrak/OCPPLAB/OCPP/ocpplab-sdk/openapi.yaml)
+- Regenerate artifacts: `make openapi`
+
+The checked-in OpenAPI files are generated from the current FastAPI app with runtime dependencies disabled, so the exported contract does not depend on Supabase or Temporal startup.
+
+## Client Generation
+
+Generate your preferred client directly from `/openapi.json` or the checked-in
+OpenAPI artifacts.
+
+## Notes
+
+- Tenant-scoped endpoints require the `X-Organization-Id` header.
+- Pydantic API schemas live under `src/schemas/`.
+- Queue producers and consumers live under `src/messaging/`.
+
+## Seed Scripts
+
+This repo also contains TypeScript data seeding files for local or sandbox database setup:
+
+- [seed.ts](/Users/yacine-elazrak/OCPPLAB/OCPP/ocpplab-sdk/seed.ts): uses Snaplet Seed to reset and populate the `brands`, `models`, `locations`, and `deployments` tables with demo data.
+- [seed.config.ts](/Users/yacine-elazrak/OCPPLAB/OCPP/ocpplab-sdk/seed.config.ts): defines the Postgres adapter and target schema selection used by the seeding tool.
+
+Prerequisites:
+
+- Node.js installed
+- project dependencies installed with your preferred JS package manager
+- access to the target Postgres database configured for Snaplet Seed
+
+## Installation
+
+```sh
+pip install ocpplab
+```
+
+## Reference
+
+A full reference for this library is available [here](https://github.com/ev-cloudx/ocpplab-sdk/blob/HEAD/./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from ocpplab import OcpplabApi
+
+client = OcpplabApi(
+    token="<token>",
+    base_url="https://yourhost.com/path/to/api",
+)
+
+client.charger_deployments.create_charger(
+    identity="CP-TEST-001",
+    brand_slug="wallbox",
+    model_slug="wallbox-pulsar-plus",
+    connector_type="Type2",
+    ws_url="wss://ocpp-toolkit-api.monta.app",
+    ocpp_version="OCPP1.6",
+    charge_point_name="Bay A01",
+    location_id="4090477f-a416-4515-a302-97aa344a0a2a",
+    location_name="La Defense Charging Hub",
+)
+```
+
+## Async Client
+
+The SDK also exports an `async` client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use `httpx.AsyncClient()` instead of `httpx.Client()` (e.g. for the `httpx_client` parameter of this client).
+
+```python
+import asyncio
+
+from ocpplab import AsyncOcpplabApi
+
+client = AsyncOcpplabApi(
+    token="<token>",
+    base_url="https://yourhost.com/path/to/api",
+)
+
+
+async def main() -> None:
+    await client.charger_deployments.create_charger(
+        identity="CP-TEST-001",
+        brand_slug="wallbox",
+        model_slug="wallbox-pulsar-plus",
+        connector_type="Type2",
+        ws_url="wss://ocpp-toolkit-api.monta.app",
+        ocpp_version="OCPP1.6",
+        charge_point_name="Bay A01",
+        location_id="4090477f-a416-4515-a302-97aa344a0a2a",
+        location_name="La Defense Charging Hub",
+    )
+
+
+asyncio.run(main())
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```python
+from ocpplab.core.api_error import ApiError
+
+try:
+    client.charger_deployments.create_charger(...)
+except ApiError as e:
+    print(e.status_code)
+    print(e.body)
+```
+
+## Advanced
+
+### Access Raw Response Data
+
+The SDK provides access to raw response data, including headers, through the `.with_raw_response` property.
+The `.with_raw_response` property returns a "raw" client that can be used to access the `.headers` and `.data` attributes.
+
+```python
+from ocpplab import OcpplabApi
+
+client = OcpplabApi(...)
+response = client.charger_deployments.with_raw_response.create_charger(...)
+print(response.headers)  # access the response headers
+print(response.status_code)  # access the response status code
+print(response.data)  # access the underlying object
+```
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retryable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `max_retries` request option to configure this behavior.
+
+```python
+client.charger_deployments.create_charger(..., request_options={
+    "max_retries": 1
+})
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
+
+```python
+from ocpplab import OcpplabApi
+
+client = OcpplabApi(..., timeout=20.0)
+
+# Override timeout for a specific method
+client.charger_deployments.create_charger(..., request_options={
+    "timeout_in_seconds": 1
+})
+```
+
+### Custom Client
+
+You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies
+and transports.
+
+```python
+import httpx
+from ocpplab import OcpplabApi
+
+client = OcpplabApi(
+    ...,
+    httpx_client=httpx.Client(
+        proxy="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!
+

ocpplab-0.1.1/README.md

@@ -0,0 +1,227 @@
+# Ocpplab Python Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fev-cloudx%2Focpplab-sdk)
+[![pypi](https://img.shields.io/pypi/v/ocpplab)](https://pypi.python.org/pypi/ocpplab)
+
+The Ocpplab Python library provides convenient access to the Ocpplab APIs from Python.
+
+## Table of Contents
+
+- [Run](#run)
+- [Contract](#contract)
+- [Client Generation](#client-generation)
+- [Notes](#notes)
+- [Seed Scripts](#seed-scripts)
+- [Installation](#installation)
+- [Reference](#reference)
+- [Usage](#usage)
+- [Async Client](#async-client)
+- [Exception Handling](#exception-handling)
+- [Advanced](#advanced)
+  - [Access Raw Response Data](#access-raw-response-data)
+  - [Retries](#retries)
+  - [Timeouts](#timeouts)
+  - [Custom Client](#custom-client)
+- [Contributing](#contributing)
+
+## Run
+
+Start the API locally with:
+
+```bash
+uvicorn src.main:app --reload --host 0.0.0.0 --port 8000
+```
+
+## Contract
+
+- Runtime OpenAPI JSON: `/openapi.json`
+- Checked-in spec: [`openapi.yaml`](/Users/yacine-elazrak/OCPPLAB/OCPP/ocpplab-sdk/openapi.yaml)
+- Regenerate artifacts: `make openapi`
+
+The checked-in OpenAPI files are generated from the current FastAPI app with runtime dependencies disabled, so the exported contract does not depend on Supabase or Temporal startup.
+
+## Client Generation
+
+Generate your preferred client directly from `/openapi.json` or the checked-in
+OpenAPI artifacts.
+
+## Notes
+
+- Tenant-scoped endpoints require the `X-Organization-Id` header.
+- Pydantic API schemas live under `src/schemas/`.
+- Queue producers and consumers live under `src/messaging/`.
+
+## Seed Scripts
+
+This repo also contains TypeScript data seeding files for local or sandbox database setup:
+
+- [seed.ts](/Users/yacine-elazrak/OCPPLAB/OCPP/ocpplab-sdk/seed.ts): uses Snaplet Seed to reset and populate the `brands`, `models`, `locations`, and `deployments` tables with demo data.
+- [seed.config.ts](/Users/yacine-elazrak/OCPPLAB/OCPP/ocpplab-sdk/seed.config.ts): defines the Postgres adapter and target schema selection used by the seeding tool.
+
+Prerequisites:
+
+- Node.js installed
+- project dependencies installed with your preferred JS package manager
+- access to the target Postgres database configured for Snaplet Seed
+
+## Installation
+
+```sh
+pip install ocpplab
+```
+
+## Reference
+
+A full reference for this library is available [here](https://github.com/ev-cloudx/ocpplab-sdk/blob/HEAD/./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from ocpplab import OcpplabApi
+
+client = OcpplabApi(
+    token="<token>",
+    base_url="https://yourhost.com/path/to/api",
+)
+
+client.charger_deployments.create_charger(
+    identity="CP-TEST-001",
+    brand_slug="wallbox",
+    model_slug="wallbox-pulsar-plus",
+    connector_type="Type2",
+    ws_url="wss://ocpp-toolkit-api.monta.app",
+    ocpp_version="OCPP1.6",
+    charge_point_name="Bay A01",
+    location_id="4090477f-a416-4515-a302-97aa344a0a2a",
+    location_name="La Defense Charging Hub",
+)
+```
+
+## Async Client
+
+The SDK also exports an `async` client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use `httpx.AsyncClient()` instead of `httpx.Client()` (e.g. for the `httpx_client` parameter of this client).
+
+```python
+import asyncio
+
+from ocpplab import AsyncOcpplabApi
+
+client = AsyncOcpplabApi(
+    token="<token>",
+    base_url="https://yourhost.com/path/to/api",
+)
+
+
+async def main() -> None:
+    await client.charger_deployments.create_charger(
+        identity="CP-TEST-001",
+        brand_slug="wallbox",
+        model_slug="wallbox-pulsar-plus",
+        connector_type="Type2",
+        ws_url="wss://ocpp-toolkit-api.monta.app",
+        ocpp_version="OCPP1.6",
+        charge_point_name="Bay A01",
+        location_id="4090477f-a416-4515-a302-97aa344a0a2a",
+        location_name="La Defense Charging Hub",
+    )
+
+
+asyncio.run(main())
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```python
+from ocpplab.core.api_error import ApiError
+
+try:
+    client.charger_deployments.create_charger(...)
+except ApiError as e:
+    print(e.status_code)
+    print(e.body)
+```
+
+## Advanced
+
+### Access Raw Response Data
+
+The SDK provides access to raw response data, including headers, through the `.with_raw_response` property.
+The `.with_raw_response` property returns a "raw" client that can be used to access the `.headers` and `.data` attributes.
+
+```python
+from ocpplab import OcpplabApi
+
+client = OcpplabApi(...)
+response = client.charger_deployments.with_raw_response.create_charger(...)
+print(response.headers)  # access the response headers
+print(response.status_code)  # access the response status code
+print(response.data)  # access the underlying object
+```
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retryable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `max_retries` request option to configure this behavior.
+
+```python
+client.charger_deployments.create_charger(..., request_options={
+    "max_retries": 1
+})
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
+
+```python
+from ocpplab import OcpplabApi
+
+client = OcpplabApi(..., timeout=20.0)
+
+# Override timeout for a specific method
+client.charger_deployments.create_charger(..., request_options={
+    "timeout_in_seconds": 1
+})
+```
+
+### Custom Client
+
+You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies
+and transports.
+
+```python
+import httpx
+from ocpplab import OcpplabApi
+
+client = OcpplabApi(
+    ...,
+    httpx_client=httpx.Client(
+        proxy="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!

ocpplab-0.1.1/pyproject.toml

@@ -0,0 +1,103 @@
+[project]
+name = "ocpplab"
+dynamic = ["version"]
+
+[tool.poetry]
+name = "ocpplab"
+version = "0.1.1"
+description = ""
+readme = "README.md"
+authors = []
+keywords = [
+    "ev",
+    "ocpp",
+    "sdk",
+    "api",
+    "charging"
+]
+
+classifiers = [
+    "Intended Audience :: Developers",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
+    "Operating System :: OS Independent",
+    "Operating System :: POSIX",
+    "Operating System :: MacOS",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: Microsoft :: Windows",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed"
+]
+packages = [
+    { include = "ocpplab", from = "src"}
+]
+
+[tool.poetry.urls]
+Documentation = 'https://github.com/ev-cloudx/ocpplab-sdk'
+Homepage = 'https://github.com/ev-cloudx/ocpplab-sdk'
+Repository = 'https://github.com/ev-cloudx/ocpplab-sdk'
+
+[tool.poetry.dependencies]
+python = "^3.10"
+aiohttp = { version = ">=3.10.0,<4", optional = true}
+httpx = ">=0.21.2"
+httpx-aiohttp = { version = "0.1.8", optional = true}
+pydantic = ">= 1.9.2"
+pydantic-core = ">=2.18.2,<2.44.0"
+typing_extensions = ">= 4.0.0"
+
+[tool.poetry.group.dev.dependencies]
+mypy = "==1.13.0"
+pytest = "^8.2.0"
+pytest-asyncio = "^1.0.0"
+pytest-xdist = "^3.6.1"
+python-dateutil = "^2.9.0"
+types-python-dateutil = "^2.9.0.20240316"
+ruff = "==0.11.5"
+
+[tool.pytest.ini_options]
+testpaths = [ "tests" ]
+asyncio_mode = "auto"
+markers = [
+    "aiohttp: tests that require httpx_aiohttp to be installed",
+]
+
+[tool.mypy]
+plugins = ["pydantic.mypy"]
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+select = [
+    "E",  # pycodestyle errors
+    "F",  # pyflakes
+    "I",  # isort
+]
+ignore = [
+    "E402",  # Module level import not at top of file
+    "E501",  # Line too long
+    "E711",  # Comparison to `None` should be `cond is not None`
+    "E712",  # Avoid equality comparisons to `True`; use `if ...:` checks
+    "E721",  # Use `is` and `is not` for type comparisons, or `isinstance()` for insinstance checks
+    "E722",  # Do not use bare `except`
+    "E731",  # Do not assign a `lambda` expression, use a `def`
+    "F821",  # Undefined name
+    "F841"   # Local variable ... is assigned to but never used
+]
+
+[tool.ruff.lint.isort]
+section-order = ["future", "standard-library", "third-party", "first-party"]
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.extras]
+aiohttp=["aiohttp", "httpx-aiohttp"]