| Name | increase JSON |
| Version |
0.130.0
JSON |
| download |
| home_page | None |
| Summary | The official Python library for the increase API |
| upload_time | 2024-10-07 23:05:14 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Increase Python API library
[](https://pypi.org/project/increase/)
The Increase Python library provides convenient access to the Increase REST API from any Python 3.7+
application. The library includes type definitions for all request params and response fields,
and offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).
## Documentation
The REST API documentation can be found on [increase.com](https://increase.com/documentation). The full API of this library can be found in [api.md](https://github.com/Increase/increase-python/tree/main/api.md).
## Installation
```sh
# install from PyPI
pip install increase
```
## Usage
The full API of this library can be found in [api.md](https://github.com/Increase/increase-python/tree/main/api.md).
```python
import os
from increase import Increase
client = Increase(
# This is the default and can be omitted
api_key=os.environ.get("INCREASE_API_KEY"),
# defaults to "production".
environment="sandbox",
)
account = client.accounts.create(
name="New Account!",
entity_id="entity_n8y8tnk2p9339ti393yi",
program_id="program_i2v2os4mwza1oetokh9i",
)
print(account.id)
```
While you can provide an `api_key` keyword argument,
we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)
to add `INCREASE_API_KEY="My API Key"` to your `.env` file
so that your API Key is not stored in source control.
## Async usage
Simply import `AsyncIncrease` instead of `Increase` and use `await` with each API call:
```python
import os
import asyncio
from increase import AsyncIncrease
client = AsyncIncrease(
# This is the default and can be omitted
api_key=os.environ.get("INCREASE_API_KEY"),
# defaults to "production".
environment="sandbox",
)
async def main() -> None:
account = await client.accounts.create(
name="New Account!",
entity_id="entity_n8y8tnk2p9339ti393yi",
program_id="program_i2v2os4mwza1oetokh9i",
)
print(account.id)
asyncio.run(main())
```
Functionality between the synchronous and asynchronous clients is otherwise identical.
## Using types
Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:
- Serializing back into JSON, `model.to_json()`
- Converting to a dictionary, `model.to_dict()`
Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.
## Pagination
List methods in the Increase API are paginated.
This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:
```python
from increase import Increase
client = Increase()
all_accounts = []
# Automatically fetches more pages as needed.
for account in client.accounts.list():
# Do something with account here
all_accounts.append(account)
print(all_accounts)
```
Or, asynchronously:
```python
import asyncio
from increase import AsyncIncrease
client = AsyncIncrease()
async def main() -> None:
all_accounts = []
# Iterate through items across all pages, issuing requests as needed.
async for account in client.accounts.list():
all_accounts.append(account)
print(all_accounts)
asyncio.run(main())
```
Alternatively, you can use the `.has_next_page()`, `.next_page_info()`, or `.get_next_page()` methods for more granular control working with pages:
```python
first_page = await client.accounts.list()
if first_page.has_next_page():
print(f"will fetch next page using these details: {first_page.next_page_info()}")
next_page = await first_page.get_next_page()
print(f"number of items we just fetched: {len(next_page.data)}")
# Remove `await` for non-async usage.
```
Or just work directly with the returned data:
```python
first_page = await client.accounts.list()
print(f"next page cursor: {first_page.next_cursor}") # => "next page cursor: ..."
for account in first_page.data:
print(account.id)
# Remove `await` for non-async usage.
```
## Nested params
Nested parameters are dictionaries, typed using `TypedDict`, for example:
```python
from increase import Increase
client = Increase()
account = client.accounts.create(
name="New Account!",
)
print(account.id)
```
## File uploads
Request parameters that correspond to file uploads can be passed as `bytes`, a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance or a tuple of `(filename, contents, media type)`.
```python
from pathlib import Path
from increase import Increase
client = Increase()
client.files.create(
file=Path("my/file.txt"),
purpose="check_image_front",
)
```
The async client uses the exact same interface. If you pass a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance, the file contents will be read asynchronously automatically.
## Handling errors
When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `increase.APIConnectionError` is raised.
When the API returns a non-success status code (that is, 4xx or 5xx
response), a subclass of `increase.APIStatusError` is raised, containing `status_code` and `response` properties.
All errors inherit from `increase.APIError`.
```python
import increase
from increase import Increase
client = Increase()
try:
client.accounts.create(
name="New Account!",
)
except increase.APIConnectionError as e:
print("The server could not be reached")
print(e.__cause__) # an underlying Exception, likely raised within httpx.
except increase.RateLimitError as e:
print("A 429 status code was received; we should back off a bit.")
except increase.APIStatusError as e:
print("Another non-200-range status code was received")
print(e.status_code)
print(e.response)
```
Error codes are as followed:
| Status Code | Error Type |
| ----------- | -------------------------- |
| 400 | `BadRequestError` |
| 401 | `AuthenticationError` |
| 403 | `PermissionDeniedError` |
| 404 | `NotFoundError` |
| 422 | `UnprocessableEntityError` |
| 429 | `RateLimitError` |
| >=500 | `InternalServerError` |
| N/A | `APIConnectionError` |
### Retries
Certain errors are automatically retried 2 times by default, with a short exponential backoff.
Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,
429 Rate Limit, and >=500 Internal errors are all retried by default.
You can use the `max_retries` option to configure or disable retry settings:
```python
from increase import Increase
# Configure the default for all requests:
client = Increase(
# default is 2
max_retries=0,
)
# Or, configure per-request:
client.with_options(max_retries=5).accounts.create(
name="New Account!",
entity_id="entity_n8y8tnk2p9339ti393yi",
program_id="program_i2v2os4mwza1oetokh9i",
)
```
### Timeouts
By default requests time out after 1 minute. You can configure this with a `timeout` option,
which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/#fine-tuning-the-configuration) object:
```python
from increase import Increase
# Configure the default for all requests:
client = Increase(
# 20 seconds (default is 1 minute)
timeout=20.0,
)
# More granular control:
client = Increase(
timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),
)
# Override per-request:
client.with_options(timeout=5.0).accounts.create(
name="New Account!",
entity_id="entity_n8y8tnk2p9339ti393yi",
program_id="program_i2v2os4mwza1oetokh9i",
)
```
On timeout, an `APITimeoutError` is thrown.
Note that requests that time out are [retried twice by default](https://github.com/Increase/increase-python/tree/main/#retries).
## Advanced
### Logging
We use the standard library [`logging`](https://docs.python.org/3/library/logging.html) module.
You can enable logging by setting the environment variable `INCREASE_LOG` to `debug`.
```shell
$ export INCREASE_LOG=debug
```
### How to tell whether `None` means `null` or missing
In an API response, a field may be explicitly `null`, or missing entirely; in either case, its value is `None` in this library. You can differentiate the two cases with `.model_fields_set`:
```py
if response.my_field is None:
if 'my_field' not in response.model_fields_set:
print('Got json like {}, without a "my_field" key present at all.')
else:
print('Got json like {"my_field": null}.')
```
### Accessing raw response data (e.g. headers)
The "raw" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g.,
```py
from increase import Increase
client = Increase()
response = client.accounts.with_raw_response.create(
name="New Account!",
entity_id="entity_n8y8tnk2p9339ti393yi",
program_id="program_i2v2os4mwza1oetokh9i",
)
print(response.headers.get('X-My-Header'))
account = response.parse() # get the object that `accounts.create()` would have returned
print(account.id)
```
These methods return an [`APIResponse`](https://github.com/Increase/increase-python/tree/main/src/increase/_response.py) object.
The async client returns an [`AsyncAPIResponse`](https://github.com/Increase/increase-python/tree/main/src/increase/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
#### `.with_streaming_response`
The above interface eagerly reads the full response body when you make the request, which may not always be what you want.
To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.
```python
with client.accounts.with_streaming_response.create(
name="New Account!",
entity_id="entity_n8y8tnk2p9339ti393yi",
program_id="program_i2v2os4mwza1oetokh9i",
) as response:
print(response.headers.get("X-My-Header"))
for line in response.iter_lines():
print(line)
```
The context manager is required so that the response will reliably be closed.
### Making custom/undocumented requests
This library is typed for convenient access to the documented API.
If you need to access undocumented endpoints, params, or response properties, the library can still be used.
#### Undocumented endpoints
To make requests to undocumented endpoints, you can make requests using `client.get`, `client.post`, and other
http verbs. Options on the client will be respected (such as retries) will be respected when making this
request.
```py
import httpx
response = client.post(
"/foo",
cast_to=httpx.Response,
body={"my_param": True},
)
print(response.headers.get("x-foo"))
```
#### Undocumented request params
If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` request
options.
#### Undocumented response properties
To access undocumented response properties, you can access the extra fields like `response.unknown_prop`. You
can also get all the extra fields on the Pydantic model as a dict with
[`response.model_extra`](https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel.model_extra).
### Configuring the HTTP client
You can directly override the [httpx client](https://www.python-httpx.org/api/#client) to customize it for your use case, including:
- Support for proxies
- Custom transports
- Additional [advanced](https://www.python-httpx.org/advanced/clients/) functionality
```python
from increase import Increase, DefaultHttpxClient
client = Increase(
# Or use the `INCREASE_BASE_URL` env var
base_url="http://my.test.server.example.com:8083",
http_client=DefaultHttpxClient(
proxies="http://my.test.proxy.example.com",
transport=httpx.HTTPTransport(local_address="0.0.0.0"),
),
)
```
You can also customize the client on a per-request basis by using `with_options()`:
```python
client.with_options(http_client=DefaultHttpxClient(...))
```
### Managing HTTP resources
By default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.
## Versioning
This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
1. Changes that only affect static types, without breaking runtime behavior.
2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals)_.
3. Changes that we do not expect to impact the vast majority of users in practice.
We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
We are keen for your feedback; please open an [issue](https://www.github.com/Increase/increase-python/issues) with questions, bugs, or suggestions.
### Determining the installed version
If you've upgraded to the latest version but aren't seeing any new features you were expecting then your python environment is likely still using an older version.
You can determine the version that is being used at runtime with:
```py
import increase
print(increase.__version__)
```
## Requirements
Python 3.7 or higher.
## Contributing
See [the contributing documentation](https://github.com/Increase/increase-python/tree/main/./CONTRIBUTING.md).
Raw data
{
"_id": null,
"home_page": null,
"name": "increase",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Increase <dev-feedback@increase.com>",
"download_url": "https://files.pythonhosted.org/packages/84/35/125e93aa1c8bbe1e5a8719230b78083a8d077611c6aab56028b94035634b/increase-0.130.0.tar.gz",
"platform": null,
"description": "# Increase Python API library\n\n[](https://pypi.org/project/increase/)\n\nThe Increase Python library provides convenient access to the Increase REST API from any Python 3.7+\napplication. The library includes type definitions for all request params and response fields,\nand offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).\n\n## Documentation\n\nThe REST API documentation can be found on [increase.com](https://increase.com/documentation). The full API of this library can be found in [api.md](https://github.com/Increase/increase-python/tree/main/api.md).\n\n## Installation\n\n```sh\n# install from PyPI\npip install increase\n```\n\n## Usage\n\nThe full API of this library can be found in [api.md](https://github.com/Increase/increase-python/tree/main/api.md).\n\n```python\nimport os\nfrom increase import Increase\n\nclient = Increase(\n # This is the default and can be omitted\n api_key=os.environ.get(\"INCREASE_API_KEY\"),\n # defaults to \"production\".\n environment=\"sandbox\",\n)\n\naccount = client.accounts.create(\n name=\"New Account!\",\n entity_id=\"entity_n8y8tnk2p9339ti393yi\",\n program_id=\"program_i2v2os4mwza1oetokh9i\",\n)\nprint(account.id)\n```\n\nWhile you can provide an `api_key` keyword argument,\nwe recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)\nto add `INCREASE_API_KEY=\"My API Key\"` to your `.env` file\nso that your API Key is not stored in source control.\n\n## Async usage\n\nSimply import `AsyncIncrease` instead of `Increase` and use `await` with each API call:\n\n```python\nimport os\nimport asyncio\nfrom increase import AsyncIncrease\n\nclient = AsyncIncrease(\n # This is the default and can be omitted\n api_key=os.environ.get(\"INCREASE_API_KEY\"),\n # defaults to \"production\".\n environment=\"sandbox\",\n)\n\n\nasync def main() -> None:\n account = await client.accounts.create(\n name=\"New Account!\",\n entity_id=\"entity_n8y8tnk2p9339ti393yi\",\n program_id=\"program_i2v2os4mwza1oetokh9i\",\n )\n print(account.id)\n\n\nasyncio.run(main())\n```\n\nFunctionality between the synchronous and asynchronous clients is otherwise identical.\n\n## Using types\n\nNested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:\n\n- Serializing back into JSON, `model.to_json()`\n- Converting to a dictionary, `model.to_dict()`\n\nTyped requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.\n\n## Pagination\n\nList methods in the Increase API are paginated.\n\nThis library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:\n\n```python\nfrom increase import Increase\n\nclient = Increase()\n\nall_accounts = []\n# Automatically fetches more pages as needed.\nfor account in client.accounts.list():\n # Do something with account here\n all_accounts.append(account)\nprint(all_accounts)\n```\n\nOr, asynchronously:\n\n```python\nimport asyncio\nfrom increase import AsyncIncrease\n\nclient = AsyncIncrease()\n\n\nasync def main() -> None:\n all_accounts = []\n # Iterate through items across all pages, issuing requests as needed.\n async for account in client.accounts.list():\n all_accounts.append(account)\n print(all_accounts)\n\n\nasyncio.run(main())\n```\n\nAlternatively, you can use the `.has_next_page()`, `.next_page_info()`, or `.get_next_page()` methods for more granular control working with pages:\n\n```python\nfirst_page = await client.accounts.list()\nif first_page.has_next_page():\n print(f\"will fetch next page using these details: {first_page.next_page_info()}\")\n next_page = await first_page.get_next_page()\n print(f\"number of items we just fetched: {len(next_page.data)}\")\n\n# Remove `await` for non-async usage.\n```\n\nOr just work directly with the returned data:\n\n```python\nfirst_page = await client.accounts.list()\n\nprint(f\"next page cursor: {first_page.next_cursor}\") # => \"next page cursor: ...\"\nfor account in first_page.data:\n print(account.id)\n\n# Remove `await` for non-async usage.\n```\n\n## Nested params\n\nNested parameters are dictionaries, typed using `TypedDict`, for example:\n\n```python\nfrom increase import Increase\n\nclient = Increase()\n\naccount = client.accounts.create(\n name=\"New Account!\",\n)\nprint(account.id)\n```\n\n## File uploads\n\nRequest parameters that correspond to file uploads can be passed as `bytes`, a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance or a tuple of `(filename, contents, media type)`.\n\n```python\nfrom pathlib import Path\nfrom increase import Increase\n\nclient = Increase()\n\nclient.files.create(\n file=Path(\"my/file.txt\"),\n purpose=\"check_image_front\",\n)\n```\n\nThe async client uses the exact same interface. If you pass a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance, the file contents will be read asynchronously automatically.\n\n## Handling errors\n\nWhen the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `increase.APIConnectionError` is raised.\n\nWhen the API returns a non-success status code (that is, 4xx or 5xx\nresponse), a subclass of `increase.APIStatusError` is raised, containing `status_code` and `response` properties.\n\nAll errors inherit from `increase.APIError`.\n\n```python\nimport increase\nfrom increase import Increase\n\nclient = Increase()\n\ntry:\n client.accounts.create(\n name=\"New Account!\",\n )\nexcept increase.APIConnectionError as e:\n print(\"The server could not be reached\")\n print(e.__cause__) # an underlying Exception, likely raised within httpx.\nexcept increase.RateLimitError as e:\n print(\"A 429 status code was received; we should back off a bit.\")\nexcept increase.APIStatusError as e:\n print(\"Another non-200-range status code was received\")\n print(e.status_code)\n print(e.response)\n```\n\nError codes are as followed:\n\n| Status Code | Error Type |\n| ----------- | -------------------------- |\n| 400 | `BadRequestError` |\n| 401 | `AuthenticationError` |\n| 403 | `PermissionDeniedError` |\n| 404 | `NotFoundError` |\n| 422 | `UnprocessableEntityError` |\n| 429 | `RateLimitError` |\n| >=500 | `InternalServerError` |\n| N/A | `APIConnectionError` |\n\n### Retries\n\nCertain errors are automatically retried 2 times by default, with a short exponential backoff.\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,\n429 Rate Limit, and >=500 Internal errors are all retried by default.\n\nYou can use the `max_retries` option to configure or disable retry settings:\n\n```python\nfrom increase import Increase\n\n# Configure the default for all requests:\nclient = Increase(\n # default is 2\n max_retries=0,\n)\n\n# Or, configure per-request:\nclient.with_options(max_retries=5).accounts.create(\n name=\"New Account!\",\n entity_id=\"entity_n8y8tnk2p9339ti393yi\",\n program_id=\"program_i2v2os4mwza1oetokh9i\",\n)\n```\n\n### Timeouts\n\nBy default requests time out after 1 minute. You can configure this with a `timeout` option,\nwhich accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/#fine-tuning-the-configuration) object:\n\n```python\nfrom increase import Increase\n\n# Configure the default for all requests:\nclient = Increase(\n # 20 seconds (default is 1 minute)\n timeout=20.0,\n)\n\n# More granular control:\nclient = Increase(\n timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),\n)\n\n# Override per-request:\nclient.with_options(timeout=5.0).accounts.create(\n name=\"New Account!\",\n entity_id=\"entity_n8y8tnk2p9339ti393yi\",\n program_id=\"program_i2v2os4mwza1oetokh9i\",\n)\n```\n\nOn timeout, an `APITimeoutError` is thrown.\n\nNote that requests that time out are [retried twice by default](https://github.com/Increase/increase-python/tree/main/#retries).\n\n## Advanced\n\n### Logging\n\nWe use the standard library [`logging`](https://docs.python.org/3/library/logging.html) module.\n\nYou can enable logging by setting the environment variable `INCREASE_LOG` to `debug`.\n\n```shell\n$ export INCREASE_LOG=debug\n```\n\n### How to tell whether `None` means `null` or missing\n\nIn an API response, a field may be explicitly `null`, or missing entirely; in either case, its value is `None` in this library. You can differentiate the two cases with `.model_fields_set`:\n\n```py\nif response.my_field is None:\n if 'my_field' not in response.model_fields_set:\n print('Got json like {}, without a \"my_field\" key present at all.')\n else:\n print('Got json like {\"my_field\": null}.')\n```\n\n### Accessing raw response data (e.g. headers)\n\nThe \"raw\" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g.,\n\n```py\nfrom increase import Increase\n\nclient = Increase()\nresponse = client.accounts.with_raw_response.create(\n name=\"New Account!\",\n entity_id=\"entity_n8y8tnk2p9339ti393yi\",\n program_id=\"program_i2v2os4mwza1oetokh9i\",\n)\nprint(response.headers.get('X-My-Header'))\n\naccount = response.parse() # get the object that `accounts.create()` would have returned\nprint(account.id)\n```\n\nThese methods return an [`APIResponse`](https://github.com/Increase/increase-python/tree/main/src/increase/_response.py) object.\n\nThe async client returns an [`AsyncAPIResponse`](https://github.com/Increase/increase-python/tree/main/src/increase/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.\n\n#### `.with_streaming_response`\n\nThe above interface eagerly reads the full response body when you make the request, which may not always be what you want.\n\nTo stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.\n\n```python\nwith client.accounts.with_streaming_response.create(\n name=\"New Account!\",\n entity_id=\"entity_n8y8tnk2p9339ti393yi\",\n program_id=\"program_i2v2os4mwza1oetokh9i\",\n) as response:\n print(response.headers.get(\"X-My-Header\"))\n\n for line in response.iter_lines():\n print(line)\n```\n\nThe context manager is required so that the response will reliably be closed.\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API.\n\nIf you need to access undocumented endpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can make requests using `client.get`, `client.post`, and other\nhttp verbs. Options on the client will be respected (such as retries) will be respected when making this\nrequest.\n\n```py\nimport httpx\n\nresponse = client.post(\n \"/foo\",\n cast_to=httpx.Response,\n body={\"my_param\": True},\n)\n\nprint(response.headers.get(\"x-foo\"))\n```\n\n#### Undocumented request params\n\nIf you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` request\noptions.\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you can access the extra fields like `response.unknown_prop`. You\ncan also get all the extra fields on the Pydantic model as a dict with\n[`response.model_extra`](https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel.model_extra).\n\n### Configuring the HTTP client\n\nYou can directly override the [httpx client](https://www.python-httpx.org/api/#client) to customize it for your use case, including:\n\n- Support for proxies\n- Custom transports\n- Additional [advanced](https://www.python-httpx.org/advanced/clients/) functionality\n\n```python\nfrom increase import Increase, DefaultHttpxClient\n\nclient = Increase(\n # Or use the `INCREASE_BASE_URL` env var\n base_url=\"http://my.test.server.example.com:8083\",\n http_client=DefaultHttpxClient(\n proxies=\"http://my.test.proxy.example.com\",\n transport=httpx.HTTPTransport(local_address=\"0.0.0.0\"),\n ),\n)\n```\n\nYou can also customize the client on a per-request basis by using `with_options()`:\n\n```python\nclient.with_options(http_client=DefaultHttpxClient(...))\n```\n\n### Managing HTTP resources\n\nBy default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.\n\n## Versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes that only affect static types, without breaking runtime behavior.\n2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals)_.\n3. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/Increase/increase-python/issues) with questions, bugs, or suggestions.\n\n### Determining the installed version\n\nIf you've upgraded to the latest version but aren't seeing any new features you were expecting then your python environment is likely still using an older version.\n\nYou can determine the version that is being used at runtime with:\n\n```py\nimport increase\nprint(increase.__version__)\n```\n\n## Requirements\n\nPython 3.7 or higher.\n\n## Contributing\n\nSee [the contributing documentation](https://github.com/Increase/increase-python/tree/main/./CONTRIBUTING.md).\n",
"bugtrack_url": null,
"license": null,
"summary": "The official Python library for the increase API",
"version": "0.130.0",
"project_urls": {
"Homepage": "https://github.com/Increase/increase-python",
"Repository": "https://github.com/Increase/increase-python"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "33e8b8cfbde997fd4c22dac756095f7c51d1b79f51cb95e56df3160b675176f9",
"md5": "ece04d9762b3a866fe1339b8edde933c",
"sha256": "50bc9cd23a704c93c73c20463266e508e6d2e5b5fc7f08bad26240fde98b20e6"
},
"downloads": -1,
"filename": "increase-0.130.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ece04d9762b3a866fe1339b8edde933c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 500987,
"upload_time": "2024-10-07T23:05:12",
"upload_time_iso_8601": "2024-10-07T23:05:12.528310Z",
"url": "https://files.pythonhosted.org/packages/33/e8/b8cfbde997fd4c22dac756095f7c51d1b79f51cb95e56df3160b675176f9/increase-0.130.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8435125e93aa1c8bbe1e5a8719230b78083a8d077611c6aab56028b94035634b",
"md5": "aa805c285aa0778df4361ba38376fc78",
"sha256": "86fe4dc28902226aa75d9a9f0948f2675197318260c1eced371a6ec72e111d38"
},
"downloads": -1,
"filename": "increase-0.130.0.tar.gz",
"has_sig": false,
"md5_digest": "aa805c285aa0778df4361ba38376fc78",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 372870,
"upload_time": "2024-10-07T23:05:14",
"upload_time_iso_8601": "2024-10-07T23:05:14.469387Z",
"url": "https://files.pythonhosted.org/packages/84/35/125e93aa1c8bbe1e5a8719230b78083a8d077611c6aab56028b94035634b/increase-0.130.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 23:05:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Increase",
"github_project": "increase-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "increase"
}
