# bannerify
<!-- Start SDK Installation [installation] -->
## SDK Installation
PIP
```bash
pip install bannerify
```
Poetry
```bash
poetry add bannerify
```
<!-- End SDK Installation [installation] -->
<!-- Start SDK Example Usage [usage] -->
## SDK Example Usage
### Example
```python
# Synchronous Example
from bannerify import Bannerify
s = Bannerify(
token="BANNERIFY_API_KEY",
)
res = s.post_v1_templates_create_image(request={
"api_key": "<value>",
"template_id": "tpl_xxxxxxxxx",
"modifications": [
{
"name": "Text 1",
"color": "#FF0000",
"src": "https://example.com/image.jpg",
"text": "Hello World",
"barcode": "1234567890",
"qrcode": "Some text",
"visible": True,
"star": 5,
},
],
})
if res is not None:
# handle response
pass
```
</br>
The same SDK client can also be used to make asychronous requests by importing asyncio.
```python
# Asynchronous Example
import asyncio
from bannerify import Bannerify
async def main():
s = Bannerify(
token="BANNERIFY_API_KEY",
)
res = await s.post_v1_templates_create_image_async(request={
"api_key": "<value>",
"template_id": "tpl_xxxxxxxxx",
"modifications": [
{
"name": "Text 1",
"color": "#FF0000",
"src": "https://example.com/image.jpg",
"text": "Hello World",
"barcode": "1234567890",
"qrcode": "Some text",
"visible": True,
"star": 5,
},
],
})
if res is not None:
# handle response
pass
asyncio.run(main())
```
<!-- End SDK Example Usage [usage] -->
<!-- Start Available Resources and Operations [operations] -->
## Available Resources and Operations
### [Bannerify SDK](https://github.com/bannerify/bannerify-python/blob/master/docs/sdks/bannerify/README.md)
* [post_v1_templates_create_image](https://github.com/bannerify/bannerify-python/blob/master/docs/sdks/bannerify/README.md#post_v1_templates_create_image) - Create an image from a template
* [post_v1_templates_create_pdf](https://github.com/bannerify/bannerify-python/blob/master/docs/sdks/bannerify/README.md#post_v1_templates_create_pdf)
* [get_v1_templates_signedurl](https://github.com/bannerify/bannerify-python/blob/master/docs/sdks/bannerify/README.md#get_v1_templates_signedurl) - Generate a signed URL for a template
* [get_v1_info](https://github.com/bannerify/bannerify-python/blob/master/docs/sdks/bannerify/README.md#get_v1_info) - Get project info
<!-- End Available Resources and Operations [operations] -->
<!-- Start Retries [retries] -->
## Retries
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:
```python
from bannerify import Bannerify
from bannerify.utils import BackoffStrategy, RetryConfig
s = Bannerify(
token="BANNERIFY_API_KEY",
)
res = s.post_v1_templates_create_image(request={
"api_key": "<value>",
"template_id": "tpl_xxxxxxxxx",
"modifications": [
{
"name": "Text 1",
"color": "#FF0000",
"src": "https://example.com/image.jpg",
"text": "Hello World",
"barcode": "1234567890",
"qrcode": "Some text",
"visible": True,
"star": 5,
},
],
},
RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
if res is not None:
# handle response
pass
```
If you'd like to override the default retry strategy for all operations that support retries, you can use the `retry_config` optional parameter when initializing the SDK:
```python
from bannerify import Bannerify
from bannerify.utils import BackoffStrategy, RetryConfig
s = Bannerify(
retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
token="BANNERIFY_API_KEY",
)
res = s.post_v1_templates_create_image(request={
"api_key": "<value>",
"template_id": "tpl_xxxxxxxxx",
"modifications": [
{
"name": "Text 1",
"color": "#FF0000",
"src": "https://example.com/image.jpg",
"text": "Hello World",
"barcode": "1234567890",
"qrcode": "Some text",
"visible": True,
"star": 5,
},
],
})
if res is not None:
# handle response
pass
```
<!-- End Retries [retries] -->
<!-- Start Error Handling [errors] -->
## Error Handling
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.
| Error Object | Status Code | Content Type |
| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
| models.PostV1TemplatesCreateImageResponseBody | 400 | application/json |
| models.ErrUnauthorized | 401 | application/json |
| models.ErrForbidden | 403 | application/json |
| models.ErrNotFound | 404 | application/json |
| models.ErrConflict | 409 | application/json |
| models.ErrTooManyRequests | 429 | application/json |
| models.ErrInternalServerError | 500 | application/json |
| models.SDKError | 4xx-5xx | */* |
### Example
```python
from bannerify import Bannerify, models
s = Bannerify(
token="BANNERIFY_API_KEY",
)
res = None
try:
res = s.post_v1_templates_create_image(request={
"api_key": "<value>",
"template_id": "tpl_xxxxxxxxx",
"modifications": [
{
"name": "Text 1",
"color": "#FF0000",
"src": "https://example.com/image.jpg",
"text": "Hello World",
"barcode": "1234567890",
"qrcode": "Some text",
"visible": True,
"star": 5,
},
],
})
except models.PostV1TemplatesCreateImageResponseBody as e:
# handle exception
raise(e)
except models.ErrUnauthorized as e:
# handle exception
raise(e)
except models.ErrForbidden as e:
# handle exception
raise(e)
except models.ErrNotFound as e:
# handle exception
raise(e)
except models.ErrConflict as e:
# handle exception
raise(e)
except models.ErrTooManyRequests as e:
# handle exception
raise(e)
except models.ErrInternalServerError as e:
# handle exception
raise(e)
except models.SDKError as e:
# handle exception
raise(e)
if res is not None:
# handle response
pass
```
<!-- End Error Handling [errors] -->
<!-- Start Server Selection [server] -->
## Server Selection
### Select Server by Index
You can override the default server globally by passing a server index to the `server_idx: int` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
| # | Server | Variables |
| - | ------ | --------- |
| 0 | `https://api.bannerify.co` | None |
#### Example
```python
from bannerify import Bannerify
s = Bannerify(
server_idx=0,
token="BANNERIFY_API_KEY",
)
res = s.post_v1_templates_create_image(request={
"api_key": "<value>",
"template_id": "tpl_xxxxxxxxx",
"modifications": [
{
"name": "Text 1",
"color": "#FF0000",
"src": "https://example.com/image.jpg",
"text": "Hello World",
"barcode": "1234567890",
"qrcode": "Some text",
"visible": True,
"star": 5,
},
],
})
if res is not None:
# handle response
pass
```
### Override Server URL Per-Client
The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
```python
from bannerify import Bannerify
s = Bannerify(
server_url="https://api.bannerify.co",
token="BANNERIFY_API_KEY",
)
res = s.post_v1_templates_create_image(request={
"api_key": "<value>",
"template_id": "tpl_xxxxxxxxx",
"modifications": [
{
"name": "Text 1",
"color": "#FF0000",
"src": "https://example.com/image.jpg",
"text": "Hello World",
"barcode": "1234567890",
"qrcode": "Some text",
"visible": True,
"star": 5,
},
],
})
if res is not None:
# handle response
pass
```
<!-- End Server Selection [server] -->
<!-- Start Custom HTTP Client [http-client] -->
## Custom HTTP Client
The Python SDK makes API calls using the [httpx](https://www.python-httpx.org/) HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance.
Depending on whether you are using the sync or async version of the SDK, you can pass an instance of `HttpClient` or `AsyncHttpClient` respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls.
This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of `httpx.Client` or `httpx.AsyncClient` directly.
For example, you could specify a header for every request that this sdk makes as follows:
```python
from bannerify import Bannerify
import httpx
http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = Bannerify(client=http_client)
```
or you could wrap the client with your own custom logic:
```python
from bannerify import Bannerify
from bannerify.httpclient import AsyncHttpClient
import httpx
class CustomClient(AsyncHttpClient):
client: AsyncHttpClient
def __init__(self, client: AsyncHttpClient):
self.client = client
async def send(
self,
request: httpx.Request,
*,
stream: bool = False,
auth: Union[
httpx._types.AuthTypes, httpx._client.UseClientDefault, None
] = httpx.USE_CLIENT_DEFAULT,
follow_redirects: Union[
bool, httpx._client.UseClientDefault
] = httpx.USE_CLIENT_DEFAULT,
) -> httpx.Response:
request.headers["Client-Level-Header"] = "added by client"
return await self.client.send(
request, stream=stream, auth=auth, follow_redirects=follow_redirects
)
def build_request(
self,
method: str,
url: httpx._types.URLTypes,
*,
content: Optional[httpx._types.RequestContent] = None,
data: Optional[httpx._types.RequestData] = None,
files: Optional[httpx._types.RequestFiles] = None,
json: Optional[Any] = None,
params: Optional[httpx._types.QueryParamTypes] = None,
headers: Optional[httpx._types.HeaderTypes] = None,
cookies: Optional[httpx._types.CookieTypes] = None,
timeout: Union[
httpx._types.TimeoutTypes, httpx._client.UseClientDefault
] = httpx.USE_CLIENT_DEFAULT,
extensions: Optional[httpx._types.RequestExtensions] = None,
) -> httpx.Request:
return self.client.build_request(
method,
url,
content=content,
data=data,
files=files,
json=json,
params=params,
headers=headers,
cookies=cookies,
timeout=timeout,
extensions=extensions,
)
s = Bannerify(async_client=CustomClient(httpx.AsyncClient()))
```
<!-- End Custom HTTP Client [http-client] -->
<!-- Start Authentication [security] -->
## Authentication
### Per-Client Security Schemes
This SDK supports the following security scheme globally:
| Name | Type | Scheme |
| ------- | ------- | ------- |
| `token` | apiKey | API key |
To authenticate with the API the `token` parameter must be set when initializing the SDK client instance. For example:
```python
from bannerify import Bannerify
s = Bannerify(
token="BANNERIFY_API_KEY",
)
res = s.post_v1_templates_create_image(request={
"api_key": "<value>",
"template_id": "tpl_xxxxxxxxx",
"modifications": [
{
"name": "Text 1",
"color": "#FF0000",
"src": "https://example.com/image.jpg",
"text": "Hello World",
"barcode": "1234567890",
"qrcode": "Some text",
"visible": True,
"star": 5,
},
],
})
if res is not None:
# handle response
pass
```
<!-- End Authentication [security] -->
<!-- Start IDE Support [idesupport] -->
## IDE Support
### PyCharm
Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.
- [PyCharm Pydantic Plugin](https://docs.pydantic.dev/latest/integrations/pycharm/)
<!-- End IDE Support [idesupport] -->
<!-- Start Debugging [debug] -->
## Debugging
You can setup your SDK to emit debug logs for SDK requests and responses.
You can pass your own logger class directly into your SDK.
```python
from bannerify import Bannerify
import logging
logging.basicConfig(level=logging.DEBUG)
s = Bannerify(debug_logger=logging.getLogger("bannerify"))
```
<!-- End Debugging [debug] -->
<!-- Placeholder for Future Speakeasy SDK Sections -->
# Development
## Maturity
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
looking for the latest version.
## Contributions
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation.
We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=<no value>&utm_campaign=python)
Raw data
{
"_id": null,
"home_page": "https://github.com/bannerify/bannerify-python.git",
"name": "bannerify",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Speakeasy",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/90/6e/636773c32bef78652c84e79970d7e65ce3fd56bbb489ed0dfc3edfe3143e/bannerify-0.2.0.tar.gz",
"platform": null,
"description": "# bannerify\n\n<!-- Start SDK Installation [installation] -->\n## SDK Installation\n\nPIP\n```bash\npip install bannerify\n```\n\nPoetry\n```bash\npoetry add bannerify\n```\n<!-- End SDK Installation [installation] -->\n\n<!-- Start SDK Example Usage [usage] -->\n## SDK Example Usage\n\n### Example\n\n```python\n# Synchronous Example\nfrom bannerify import Bannerify\n\ns = Bannerify(\n token=\"BANNERIFY_API_KEY\",\n)\n\n\nres = s.post_v1_templates_create_image(request={\n \"api_key\": \"<value>\",\n \"template_id\": \"tpl_xxxxxxxxx\",\n \"modifications\": [\n {\n \"name\": \"Text 1\",\n \"color\": \"#FF0000\",\n \"src\": \"https://example.com/image.jpg\",\n \"text\": \"Hello World\",\n \"barcode\": \"1234567890\",\n \"qrcode\": \"Some text\",\n \"visible\": True,\n \"star\": 5,\n },\n ],\n})\n\nif res is not None:\n # handle response\n pass\n```\n\n</br>\n\nThe same SDK client can also be used to make asychronous requests by importing asyncio.\n```python\n# Asynchronous Example\nimport asyncio\nfrom bannerify import Bannerify\n\nasync def main():\n s = Bannerify(\n token=\"BANNERIFY_API_KEY\",\n )\n res = await s.post_v1_templates_create_image_async(request={\n \"api_key\": \"<value>\",\n \"template_id\": \"tpl_xxxxxxxxx\",\n \"modifications\": [\n {\n \"name\": \"Text 1\",\n \"color\": \"#FF0000\",\n \"src\": \"https://example.com/image.jpg\",\n \"text\": \"Hello World\",\n \"barcode\": \"1234567890\",\n \"qrcode\": \"Some text\",\n \"visible\": True,\n \"star\": 5,\n },\n ],\n })\n if res is not None:\n # handle response\n pass\n\nasyncio.run(main())\n```\n<!-- End SDK Example Usage [usage] -->\n\n<!-- Start Available Resources and Operations [operations] -->\n## Available Resources and Operations\n\n### [Bannerify SDK](https://github.com/bannerify/bannerify-python/blob/master/docs/sdks/bannerify/README.md)\n\n* [post_v1_templates_create_image](https://github.com/bannerify/bannerify-python/blob/master/docs/sdks/bannerify/README.md#post_v1_templates_create_image) - Create an image from a template\n* [post_v1_templates_create_pdf](https://github.com/bannerify/bannerify-python/blob/master/docs/sdks/bannerify/README.md#post_v1_templates_create_pdf)\n* [get_v1_templates_signedurl](https://github.com/bannerify/bannerify-python/blob/master/docs/sdks/bannerify/README.md#get_v1_templates_signedurl) - Generate a signed URL for a template\n* [get_v1_info](https://github.com/bannerify/bannerify-python/blob/master/docs/sdks/bannerify/README.md#get_v1_info) - Get project info\n<!-- End Available Resources and Operations [operations] -->\n\n<!-- Start Retries [retries] -->\n## Retries\n\nSome of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.\n\nTo change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:\n```python\nfrom bannerify import Bannerify\nfrom bannerify.utils import BackoffStrategy, RetryConfig\n\ns = Bannerify(\n token=\"BANNERIFY_API_KEY\",\n)\n\n\nres = s.post_v1_templates_create_image(request={\n \"api_key\": \"<value>\",\n \"template_id\": \"tpl_xxxxxxxxx\",\n \"modifications\": [\n {\n \"name\": \"Text 1\",\n \"color\": \"#FF0000\",\n \"src\": \"https://example.com/image.jpg\",\n \"text\": \"Hello World\",\n \"barcode\": \"1234567890\",\n \"qrcode\": \"Some text\",\n \"visible\": True,\n \"star\": 5,\n },\n ],\n},\n RetryConfig(\"backoff\", BackoffStrategy(1, 50, 1.1, 100), False))\n\nif res is not None:\n # handle response\n pass\n\n```\n\nIf you'd like to override the default retry strategy for all operations that support retries, you can use the `retry_config` optional parameter when initializing the SDK:\n```python\nfrom bannerify import Bannerify\nfrom bannerify.utils import BackoffStrategy, RetryConfig\n\ns = Bannerify(\n retry_config=RetryConfig(\"backoff\", BackoffStrategy(1, 50, 1.1, 100), False),\n token=\"BANNERIFY_API_KEY\",\n)\n\n\nres = s.post_v1_templates_create_image(request={\n \"api_key\": \"<value>\",\n \"template_id\": \"tpl_xxxxxxxxx\",\n \"modifications\": [\n {\n \"name\": \"Text 1\",\n \"color\": \"#FF0000\",\n \"src\": \"https://example.com/image.jpg\",\n \"text\": \"Hello World\",\n \"barcode\": \"1234567890\",\n \"qrcode\": \"Some text\",\n \"visible\": True,\n \"star\": 5,\n },\n ],\n})\n\nif res is not None:\n # handle response\n pass\n\n```\n<!-- End Retries [retries] -->\n\n<!-- Start Error Handling [errors] -->\n## Error Handling\n\nHandling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.\n\n| Error Object | Status Code | Content Type |\n| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |\n| models.PostV1TemplatesCreateImageResponseBody | 400 | application/json |\n| models.ErrUnauthorized | 401 | application/json |\n| models.ErrForbidden | 403 | application/json |\n| models.ErrNotFound | 404 | application/json |\n| models.ErrConflict | 409 | application/json |\n| models.ErrTooManyRequests | 429 | application/json |\n| models.ErrInternalServerError | 500 | application/json |\n| models.SDKError | 4xx-5xx | */* |\n\n### Example\n\n```python\nfrom bannerify import Bannerify, models\n\ns = Bannerify(\n token=\"BANNERIFY_API_KEY\",\n)\n\nres = None\ntry:\n res = s.post_v1_templates_create_image(request={\n \"api_key\": \"<value>\",\n \"template_id\": \"tpl_xxxxxxxxx\",\n \"modifications\": [\n {\n \"name\": \"Text 1\",\n \"color\": \"#FF0000\",\n \"src\": \"https://example.com/image.jpg\",\n \"text\": \"Hello World\",\n \"barcode\": \"1234567890\",\n \"qrcode\": \"Some text\",\n \"visible\": True,\n \"star\": 5,\n },\n ],\n})\n\nexcept models.PostV1TemplatesCreateImageResponseBody as e:\n # handle exception\n raise(e)\nexcept models.ErrUnauthorized as e:\n # handle exception\n raise(e)\nexcept models.ErrForbidden as e:\n # handle exception\n raise(e)\nexcept models.ErrNotFound as e:\n # handle exception\n raise(e)\nexcept models.ErrConflict as e:\n # handle exception\n raise(e)\nexcept models.ErrTooManyRequests as e:\n # handle exception\n raise(e)\nexcept models.ErrInternalServerError as e:\n # handle exception\n raise(e)\nexcept models.SDKError as e:\n # handle exception\n raise(e)\n\nif res is not None:\n # handle response\n pass\n\n```\n<!-- End Error Handling [errors] -->\n\n<!-- Start Server Selection [server] -->\n## Server Selection\n\n### Select Server by Index\n\nYou can override the default server globally by passing a server index to the `server_idx: int` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:\n\n| # | Server | Variables |\n| - | ------ | --------- |\n| 0 | `https://api.bannerify.co` | None |\n\n#### Example\n\n```python\nfrom bannerify import Bannerify\n\ns = Bannerify(\n server_idx=0,\n token=\"BANNERIFY_API_KEY\",\n)\n\n\nres = s.post_v1_templates_create_image(request={\n \"api_key\": \"<value>\",\n \"template_id\": \"tpl_xxxxxxxxx\",\n \"modifications\": [\n {\n \"name\": \"Text 1\",\n \"color\": \"#FF0000\",\n \"src\": \"https://example.com/image.jpg\",\n \"text\": \"Hello World\",\n \"barcode\": \"1234567890\",\n \"qrcode\": \"Some text\",\n \"visible\": True,\n \"star\": 5,\n },\n ],\n})\n\nif res is not None:\n # handle response\n pass\n\n```\n\n\n### Override Server URL Per-Client\n\nThe default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:\n```python\nfrom bannerify import Bannerify\n\ns = Bannerify(\n server_url=\"https://api.bannerify.co\",\n token=\"BANNERIFY_API_KEY\",\n)\n\n\nres = s.post_v1_templates_create_image(request={\n \"api_key\": \"<value>\",\n \"template_id\": \"tpl_xxxxxxxxx\",\n \"modifications\": [\n {\n \"name\": \"Text 1\",\n \"color\": \"#FF0000\",\n \"src\": \"https://example.com/image.jpg\",\n \"text\": \"Hello World\",\n \"barcode\": \"1234567890\",\n \"qrcode\": \"Some text\",\n \"visible\": True,\n \"star\": 5,\n },\n ],\n})\n\nif res is not None:\n # handle response\n pass\n\n```\n<!-- End Server Selection [server] -->\n\n<!-- Start Custom HTTP Client [http-client] -->\n## Custom HTTP Client\n\nThe Python SDK makes API calls using the [httpx](https://www.python-httpx.org/) HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance.\nDepending on whether you are using the sync or async version of the SDK, you can pass an instance of `HttpClient` or `AsyncHttpClient` respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls.\nThis allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of `httpx.Client` or `httpx.AsyncClient` directly.\n\nFor example, you could specify a header for every request that this sdk makes as follows:\n```python\nfrom bannerify import Bannerify\nimport httpx\n\nhttp_client = httpx.Client(headers={\"x-custom-header\": \"someValue\"})\ns = Bannerify(client=http_client)\n```\n\nor you could wrap the client with your own custom logic:\n```python\nfrom bannerify import Bannerify\nfrom bannerify.httpclient import AsyncHttpClient\nimport httpx\n\nclass CustomClient(AsyncHttpClient):\n client: AsyncHttpClient\n\n def __init__(self, client: AsyncHttpClient):\n self.client = client\n\n async def send(\n self,\n request: httpx.Request,\n *,\n stream: bool = False,\n auth: Union[\n httpx._types.AuthTypes, httpx._client.UseClientDefault, None\n ] = httpx.USE_CLIENT_DEFAULT,\n follow_redirects: Union[\n bool, httpx._client.UseClientDefault\n ] = httpx.USE_CLIENT_DEFAULT,\n ) -> httpx.Response:\n request.headers[\"Client-Level-Header\"] = \"added by client\"\n\n return await self.client.send(\n request, stream=stream, auth=auth, follow_redirects=follow_redirects\n )\n\n def build_request(\n self,\n method: str,\n url: httpx._types.URLTypes,\n *,\n content: Optional[httpx._types.RequestContent] = None,\n data: Optional[httpx._types.RequestData] = None,\n files: Optional[httpx._types.RequestFiles] = None,\n json: Optional[Any] = None,\n params: Optional[httpx._types.QueryParamTypes] = None,\n headers: Optional[httpx._types.HeaderTypes] = None,\n cookies: Optional[httpx._types.CookieTypes] = None,\n timeout: Union[\n httpx._types.TimeoutTypes, httpx._client.UseClientDefault\n ] = httpx.USE_CLIENT_DEFAULT,\n extensions: Optional[httpx._types.RequestExtensions] = None,\n ) -> httpx.Request:\n return self.client.build_request(\n method,\n url,\n content=content,\n data=data,\n files=files,\n json=json,\n params=params,\n headers=headers,\n cookies=cookies,\n timeout=timeout,\n extensions=extensions,\n )\n\ns = Bannerify(async_client=CustomClient(httpx.AsyncClient()))\n```\n<!-- End Custom HTTP Client [http-client] -->\n\n<!-- Start Authentication [security] -->\n## Authentication\n\n### Per-Client Security Schemes\n\nThis SDK supports the following security scheme globally:\n\n| Name | Type | Scheme |\n| ------- | ------- | ------- |\n| `token` | apiKey | API key |\n\nTo authenticate with the API the `token` parameter must be set when initializing the SDK client instance. For example:\n```python\nfrom bannerify import Bannerify\n\ns = Bannerify(\n token=\"BANNERIFY_API_KEY\",\n)\n\n\nres = s.post_v1_templates_create_image(request={\n \"api_key\": \"<value>\",\n \"template_id\": \"tpl_xxxxxxxxx\",\n \"modifications\": [\n {\n \"name\": \"Text 1\",\n \"color\": \"#FF0000\",\n \"src\": \"https://example.com/image.jpg\",\n \"text\": \"Hello World\",\n \"barcode\": \"1234567890\",\n \"qrcode\": \"Some text\",\n \"visible\": True,\n \"star\": 5,\n },\n ],\n})\n\nif res is not None:\n # handle response\n pass\n\n```\n<!-- End Authentication [security] -->\n\n<!-- Start IDE Support [idesupport] -->\n## IDE Support\n\n### PyCharm\n\nGenerally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.\n\n- [PyCharm Pydantic Plugin](https://docs.pydantic.dev/latest/integrations/pycharm/)\n<!-- End IDE Support [idesupport] -->\n\n<!-- Start Debugging [debug] -->\n## Debugging\n\nYou can setup your SDK to emit debug logs for SDK requests and responses.\n\nYou can pass your own logger class directly into your SDK.\n```python\nfrom bannerify import Bannerify\nimport logging\n\nlogging.basicConfig(level=logging.DEBUG)\ns = Bannerify(debug_logger=logging.getLogger(\"bannerify\"))\n```\n<!-- End Debugging [debug] -->\n\n<!-- Placeholder for Future Speakeasy SDK Sections -->\n\n# Development\n\n## Maturity\n\nThis SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage\nto a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally\nlooking for the latest version.\n\n## Contributions\n\nWhile we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. \nWe look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release. \n\n### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=<no value>&utm_campaign=python)\n",
"bugtrack_url": null,
"license": null,
"summary": "Python Client SDK Generated by Speakeasy.",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/bannerify/bannerify-python.git",
"Repository": "https://github.com/bannerify/bannerify-python.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "83bc67973db51777d4b8009db94b52b9661446ec1daa14a3669b53af4f1855e3",
"md5": "c057285b6d658a0f8f1788cdcd5d46b8",
"sha256": "27ce5729f87d089d99c1f524f57089a4a1544079a4501aecbf198a54e8b05303"
},
"downloads": -1,
"filename": "bannerify-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c057285b6d658a0f8f1788cdcd5d46b8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 43984,
"upload_time": "2024-08-29T19:08:02",
"upload_time_iso_8601": "2024-08-29T19:08:02.770443Z",
"url": "https://files.pythonhosted.org/packages/83/bc/67973db51777d4b8009db94b52b9661446ec1daa14a3669b53af4f1855e3/bannerify-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "906e636773c32bef78652c84e79970d7e65ce3fd56bbb489ed0dfc3edfe3143e",
"md5": "3e18821b7cb7911020781785d3936354",
"sha256": "60344d7739a1673d112e6b5d1999deb21cc9800e6d2680ff32514e59cb68bffd"
},
"downloads": -1,
"filename": "bannerify-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "3e18821b7cb7911020781785d3936354",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 30013,
"upload_time": "2024-08-29T19:08:06",
"upload_time_iso_8601": "2024-08-29T19:08:06.809437Z",
"url": "https://files.pythonhosted.org/packages/90/6e/636773c32bef78652c84e79970d7e65ce3fd56bbb489ed0dfc3edfe3143e/bannerify-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-29 19:08:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bannerify",
"github_project": "bannerify-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "bannerify"
}
JSON
