It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:
- 🛠 Make your SDK feel handcrafted by customizing it
- ♻️ Refine your SDK quickly by iterating locally with the Speakeasy CLI
- 🎁 Publish your SDK to package managers by configuring automatic publishing
- ✨ When ready to productionize, delete this section from the README
The Speakeasy Bar: A bar that serves drinks.
A secret underground bar that serves drinks to those in the know.
For more information about the API: The Speakeasy Bar Documentation.
The SDK can be installed with either pip or poetry package managers.
PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.
pip install git+https://github.com/speakeasy-sdks/bar-python.gitPoetry is a modern tool that simplifies dependency management and package publishing by using a single pyproject.toml file to handle project metadata and dependencies.
poetry add git+https://github.com/speakeasy-sdks/bar-python.gitGenerally, 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.
# Synchronous Example
from speakeasy_bar_py import BarPython
from speakeasy_bar_py.models import components
with BarPython(
security=components.Security(
api_key="<YOUR_API_KEY_HERE>",
),
) as s:
res = s.drinks.list_drinks()
if res.drinks is not None:
# handle response
passThe same SDK client can also be used to make asychronous requests by importing asyncio.
# Asynchronous Example
import asyncio
from speakeasy_bar_py import BarPython
from speakeasy_bar_py.models import components
async def main():
async with BarPython(
security=components.Security(
api_key="<YOUR_API_KEY_HERE>",
),
) as s:
res = await s.drinks.list_drinks_async()
if res.drinks is not None:
# handle response
pass
asyncio.run(main())# Synchronous Example
from speakeasy_bar_py import BarPython
from speakeasy_bar_py.models import components
with BarPython(
security=components.Security(
api_key="<YOUR_API_KEY_HERE>",
),
) as s:
res = s.orders.create_order(request_body=[
{
"type": components.OrderType.DRINK,
"product_code": "APM-1F2D3",
"quantity": 837978,
},
{
"type": components.OrderType.DRINK,
"product_code": "AC-A2DF3",
"quantity": 589796,
},
])
if res.order is not None:
# handle response
passThe same SDK client can also be used to make asychronous requests by importing asyncio.
# Asynchronous Example
import asyncio
from speakeasy_bar_py import BarPython
from speakeasy_bar_py.models import components
async def main():
async with BarPython(
security=components.Security(
api_key="<YOUR_API_KEY_HERE>",
),
) as s:
res = await s.orders.create_order_async(request_body=[
{
"type": components.OrderType.DRINK,
"product_code": "APM-1F2D3",
"quantity": 837978,
},
{
"type": components.OrderType.DRINK,
"product_code": "AC-A2DF3",
"quantity": 589796,
},
])
if res.order is not None:
# handle response
pass
asyncio.run(main())Available methods
- authenticate - Authenticate with the API by providing a username and password.
- subscribe_to_webhooks - Subscribe to webhooks.
- list_drinks - Get a list of drinks.
- get_drink - Get a drink.
- list_ingredients - Get a list of ingredients.
- create_order - Create an order.
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:
from barpython.utils import BackoffStrategy, RetryConfig
from speakeasy_bar_py import BarPython
with BarPython() as s:
res = s.authentication.authenticate(request={},
RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
if res.object is not None:
# handle response
passIf 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:
from barpython.utils import BackoffStrategy, RetryConfig
from speakeasy_bar_py import BarPython
with BarPython(
retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
) as s:
res = s.authentication.authenticate(request={})
if res.object is not None:
# handle response
passHandling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.
By default, an API error will raise a errors.SDKError exception, which has the following properties:
| Property | Type | Description |
|---|---|---|
.status_code |
int | The HTTP status code |
.message |
str | The error message |
.raw_response |
httpx.Response | The raw HTTP response |
.body |
str | The response content |
When custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the authenticate_async method may raise the following exceptions:
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.APIError | 5XX | application/json |
| errors.SDKError | 4XX | */* |
from speakeasy_bar_py import BarPython
from speakeasy_bar_py.models import errors
with BarPython() as s:
res = None
try:
res = s.authentication.authenticate(request={})
if res.object is not None:
# handle response
pass
except errors.APIError as e:
# handle e.data: errors.APIErrorData
raise(e)
except errors.SDKError as e:
# handle exception
raise(e)You can override the default server globally by passing a server name to the server: str 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 names associated with the available servers:
| Name | Server | Variables | Default values |
|---|---|---|---|
prod |
https://speakeasy.bar |
||
staging |
https://staging.speakeasy.bar |
||
customer |
https://{organization}.{environment}.speakeasy.bar |
organization: strenvironment: models.ServerEnvironment |
"api""prod" |
If the selected server has variables, you may override their default values through the additional parameters made available in the SDK constructor.
from speakeasy_bar_py import BarPython
with BarPython(
server="customer",
) as s:
res = s.authentication.authenticate(request={})
if res.object is not None:
# handle response
passThe 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:
from speakeasy_bar_py import BarPython
with BarPython(
server_url="https://speakeasy.bar",
) as s:
res = s.authentication.authenticate(request={})
if res.object is not None:
# handle response
passThe Python SDK makes API calls using the httpx 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:
from speakeasy_bar_py import BarPython
import httpx
http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = BarPython(client=http_client)or you could wrap the client with your own custom logic:
from speakeasy_bar_py import BarPython
from speakeasy_bar_py.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 = BarPython(async_client=CustomClient(httpx.AsyncClient()))This SDK supports the following security schemes globally:
| Name | Type | Scheme |
|---|---|---|
api_key |
apiKey | API key |
client_credentials |
oauth2 | OAuth2 token |
You can set the security parameters through the security optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:
from speakeasy_bar_py import BarPython
from speakeasy_bar_py.models import components
with BarPython(
security=components.Security(
api_key="<YOUR_API_KEY_HERE>",
),
) as s:
res = s.authentication.authenticate(request={})
if res.object is not None:
# handle response
passYou can setup your SDK to emit debug logs for SDK requests and responses.
You can pass your own logger class directly into your SDK.
from speakeasy_bar_py import BarPython
import logging
logging.basicConfig(level=logging.DEBUG)
s = BarPython(debug_logger=logging.getLogger("speakeasy_bar_py"))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.
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.