Learn more about the Dub.co Python SDK in the official documentation.
PIP
pip install dub
Poetry
poetry add dub
# Synchronous Example
from dub import Dub
s = Dub(
token="DUB_API_KEY",
)
res = s.links.create(request={
"url": "https://google/com",
"external_id": "123456",
"tag_ids": [
"clux0rgak00011...",
],
})
if res is not None:
# handle response
pass
The same SDK client can also be used to make asychronous requests by importing asyncio.
# Asynchronous Example
import asyncio
from dub import Dub
async def main():
s = Dub(
token="DUB_API_KEY",
)
res = await s.links.create_async(request={
"url": "https://google/com",
"external_id": "123456",
"tag_ids": [
"clux0rgak00011...",
],
})
if res is not None:
# handle response
pass
asyncio.run(main())
# Synchronous Example
from dub import Dub
s = Dub(
token="DUB_API_KEY",
)
res = s.links.upsert(request={
"url": "https://google/com",
"external_id": "123456",
"tag_ids": [
"clux0rgak00011...",
],
})
if res is not None:
# handle response
pass
The same SDK client can also be used to make asychronous requests by importing asyncio.
# Asynchronous Example
import asyncio
from dub import Dub
async def main():
s = Dub(
token="DUB_API_KEY",
)
res = await s.links.upsert_async(request={
"url": "https://google/com",
"external_id": "123456",
"tag_ids": [
"clux0rgak00011...",
],
})
if res is not None:
# handle response
pass
asyncio.run(main())
- list - Retrieve a list of links
- create - Create a new link
- count - Retrieve links count
- get - Retrieve a link
- delete - Delete a link
- update - Update a link
- create_many - Bulk create links
- update_many - Bulk update links
- upsert - Upsert a link
- get - Retrieve a QR code
- retrieve - Retrieve analytics for a link, a domain, or the authenticated workspace.
- list - Retrieve a list of domains
- create - Create a domain
- delete - Delete a domain
- update - Update a domain
- get - Retrieve the metatags for a URL
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 |
---|---|---|
errors.BadRequest | 400 | application/json |
errors.Unauthorized | 401 | application/json |
errors.Forbidden | 403 | application/json |
errors.NotFound | 404 | application/json |
errors.Conflict | 409 | application/json |
errors.InviteExpired | 410 | application/json |
errors.UnprocessableEntity | 422 | application/json |
errors.RateLimitExceeded | 429 | application/json |
errors.InternalServerError | 500 | application/json |
errors.SDKError | 4xx-5xx | / |
from dub import Dub
from dub.models import errors
s = Dub(
token="DUB_API_KEY",
)
res = None
try:
res = s.links.list(request={})
except errors.BadRequest as e:
# handle exception
raise(e)
except errors.Unauthorized as e:
# handle exception
raise(e)
except errors.Forbidden as e:
# handle exception
raise(e)
except errors.NotFound as e:
# handle exception
raise(e)
except errors.Conflict as e:
# handle exception
raise(e)
except errors.InviteExpired as e:
# handle exception
raise(e)
except errors.UnprocessableEntity as e:
# handle exception
raise(e)
except errors.RateLimitExceeded as e:
# handle exception
raise(e)
except errors.InternalServerError as e:
# handle exception
raise(e)
except errors.SDKError as e:
# handle exception
raise(e)
if res is not None:
# handle response
pass
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.dub.co |
None |
from dub import Dub
s = Dub(
server_idx=0,
token="DUB_API_KEY",
)
res = s.links.list(request={})
if res is not None:
# handle response
pass
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:
from dub import Dub
s = Dub(
server_url="https://api.dub.co",
token="DUB_API_KEY",
)
res = s.links.list(request={})
if res is not None:
# handle response
pass
The 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 dub import Dub
import httpx
http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = Dub(client=http_client)
or you could wrap the client with your own custom logic:
from dub import Dub
from dub.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 = Dub(async_client=CustomClient(httpx.AsyncClient()))
This SDK supports the following security scheme globally:
Name | Type | Scheme |
---|---|---|
token |
http | HTTP Bearer |
To authenticate with the API the token
parameter must be set when initializing the SDK client instance. For example:
from dub import Dub
s = Dub(
token="DUB_API_KEY",
)
res = s.links.list(request={})
if res is not None:
# handle response
pass
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. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!