-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
2629191
commit 86018bb
Showing
694 changed files
with
115,085 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# Specify files that shouldn't be modified by Fern |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
name: ci | ||
|
||
on: [push] | ||
jobs: | ||
compile: | ||
runs-on: ubuntu-20.04 | ||
steps: | ||
- name: Checkout repo | ||
uses: actions/checkout@v3 | ||
- name: Set up python | ||
uses: actions/setup-python@v4 | ||
with: | ||
python-version: 3.8 | ||
- name: Bootstrap poetry | ||
run: | | ||
curl -sSL https://install.python-poetry.org | python - -y --version 1.5.1 | ||
- name: Install dependencies | ||
run: poetry install | ||
- name: Compile | ||
run: poetry run mypy . | ||
test: | ||
runs-on: ubuntu-20.04 | ||
steps: | ||
- name: Checkout repo | ||
uses: actions/checkout@v3 | ||
- name: Set up python | ||
uses: actions/setup-python@v4 | ||
with: | ||
python-version: 3.8 | ||
- name: Bootstrap poetry | ||
run: | | ||
curl -sSL https://install.python-poetry.org | python - -y --version 1.5.1 | ||
- name: Install dependencies | ||
run: poetry install | ||
|
||
- name: Test | ||
run: poetry run pytest -rP . |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
dist/ | ||
.mypy_cache/ | ||
__pycache__/ | ||
poetry.toml | ||
.ruff_cache/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,146 @@ | ||
# monite-python-client | ||
# Monite 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%2Fteam-monite%2Fmonite-python-client) | ||
[![pypi](https://img.shields.io/pypi/v/monite)](https://pypi.python.org/pypi/monite) | ||
|
||
The Monite Python library provides convenient access to the Monite API from Python. | ||
|
||
## Documentation | ||
|
||
API reference documentation is available [here](https://docs.monite.com/api). | ||
|
||
## Installation | ||
|
||
```sh | ||
pip install monite | ||
``` | ||
|
||
## Reference | ||
|
||
A full reference for this library is available [here](./reference.md). | ||
|
||
## Usage | ||
|
||
Instantiate and use the client with the following: | ||
|
||
```python | ||
from monite import Monite | ||
|
||
client = Monite( | ||
monite_version="YOUR_MONITE_VERSION", | ||
monite_entity_id="YOUR_MONITE_ENTITY_ID", | ||
token="YOUR_TOKEN", | ||
) | ||
client.products.create( | ||
name="name", | ||
) | ||
``` | ||
|
||
## Async Client | ||
|
||
The SDK also exports an `async` client so that you can make non-blocking calls to our API. | ||
|
||
```python | ||
import asyncio | ||
|
||
from monite import AsyncMonite | ||
|
||
client = AsyncMonite( | ||
monite_version="YOUR_MONITE_VERSION", | ||
monite_entity_id="YOUR_MONITE_ENTITY_ID", | ||
token="YOUR_TOKEN", | ||
) | ||
|
||
|
||
async def main() -> None: | ||
await client.products.create( | ||
name="name", | ||
) | ||
|
||
|
||
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 monite.core.api_error import ApiError | ||
|
||
try: | ||
client.products.create(...) | ||
except ApiError as e: | ||
print(e.status_code) | ||
print(e.body) | ||
``` | ||
|
||
## Advanced | ||
|
||
### Retries | ||
|
||
The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long | ||
as the request is deemed retriable and the number of retry attempts has not grown larger than the configured | ||
retry limit (default: 2). | ||
|
||
A request is deemed retriable 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.products.create(..., 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 monite import Monite | ||
|
||
client = Monite( | ||
..., | ||
timeout=20.0, | ||
) | ||
|
||
|
||
# Override timeout for a specific method | ||
client.products.create(..., 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 monite import Monite | ||
|
||
client = Monite( | ||
..., | ||
httpx_client=httpx.Client( | ||
proxies="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! |
Oops, something went wrong.