- Notifications
You must be signed in to change notification settings - Fork4
dubinc/dub-python
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Learn more about the Dub.co Python SDK in theofficial documentation.
Dub.co API: Dub is link management infrastructure for companies to create marketing campaigns, link sharing features, and referral programs.
- SDK Installation
- SDK Example Usage
- Available Resources and Operations
- Error Handling
- Server Selection
- Custom HTTP Client
- Authentication
- Retries
- Pagination
- Resource Management
- Debugging
- IDE Support
- Development
Note
Python version upgrade policy
Once a Python version reaches itsofficial end of life date, a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.
The SDK can be installed with eitherpip orpoetry 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 dub
Poetry is a modern tool that simplifies dependency management and package publishing by using a singlepyproject.toml file to handle project metadata and dependencies.
poetry add dub
You can use this SDK in a Python shell withuv and theuvx command that comes with it like so:
uvx --from dub python
It's also possible to write a standalone Python script without needing to set up a whole project like so:
#!/usr/bin/env -S uv run --script# /// script# requires-python = ">=3.9"# dependencies = [# "dub",# ]# ///fromdubimportDubsdk=Dub(# SDK arguments)# Rest of script here...
Once that is saved to a file, you can run it withuv run script.py wherescript.py can be replaced with the actual file name.
# Synchronous ExamplefromdubimportDubwithDub(token="DUB_API_KEY",)asd_client:res=d_client.links.create(request={"url":"https://google.com","external_id":"123456","tag_ids": ["clux0rgak00011...", ], })assertresisnotNone# Handle responseprint(res)
The same SDK client can also be used to make asychronous requests by importing asyncio.
# Asynchronous ExampleimportasynciofromdubimportDubasyncdefmain():asyncwithDub(token="DUB_API_KEY", )asd_client:res=awaitd_client.links.create_async(request={"url":"https://google.com","external_id":"123456","tag_ids": ["clux0rgak00011...", ], })assertresisnotNone# Handle responseprint(res)asyncio.run(main())
# Synchronous ExamplefromdubimportDubwithDub(token="DUB_API_KEY",)asd_client:res=d_client.links.upsert(request={"url":"https://google.com","external_id":"123456","tag_ids": ["clux0rgak00011...", ], })assertresisnotNone# Handle responseprint(res)
The same SDK client can also be used to make asychronous requests by importing asyncio.
# Asynchronous ExampleimportasynciofromdubimportDubasyncdefmain():asyncwithDub(token="DUB_API_KEY", )asd_client:res=awaitd_client.links.upsert_async(request={"url":"https://google.com","external_id":"123456","tag_ids": ["clux0rgak00011...", ], })assertresisnotNone# Handle responseprint(res)asyncio.run(main())
Available methods
- retrieve - Retrieve analytics for a link, a domain, or the authenticated workspace.
- list - Retrieve a list of customers
create- Create a customer⚠️ Deprecated- get - Retrieve a customer
- update - Update a customer
- delete - Delete a customer
- create - Create a domain
- list - Retrieve a list of domains
- update - Update a domain
- delete - Delete a domain
- referrals - Create a new referrals embed token
- list - Retrieve a list of events
- create - Create a new folder
- list - Retrieve a list of folders
- update - Update a folder
- delete - Delete a folder
- create - Create a new link
- list - Retrieve a list of links
- count - Retrieve links count
- get - Retrieve a link
- update - Update a link
- delete - Delete a link
- create_many - Bulk create links
- update_many - Bulk update links
- delete_many - Bulk delete links
- upsert - Upsert a link
- get - Retrieve the metatags for a URL
- create - Create a new partner
- create_link - Create a link for a partner
- upsert_link - Upsert a link for a partner
- analytics - Retrieve analytics for a partner
- update_sale - Update a sale for a partner.
- get - Retrieve a QR code
Handling 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 respectiveErrors tables in SDK docs for more details on possible exception types for each operation. For example, thecreate_async method may raise the following exceptions:
| Error Type | 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 | */* |
fromdubimportDubfromdub.modelsimporterrorswithDub(token="DUB_API_KEY",)asd_client:res=Nonetry:res=d_client.links.create(request={"url":"https://google.com","external_id":"123456","tag_ids": ["clux0rgak00011...", ], })assertresisnotNone# Handle responseprint(res)excepterrors.BadRequestase:# handle e.data: errors.BadRequestDataraise(e)excepterrors.Unauthorizedase:# handle e.data: errors.UnauthorizedDataraise(e)excepterrors.Forbiddenase:# handle e.data: errors.ForbiddenDataraise(e)excepterrors.NotFoundase:# handle e.data: errors.NotFoundDataraise(e)excepterrors.Conflictase:# handle e.data: errors.ConflictDataraise(e)excepterrors.InviteExpiredase:# handle e.data: errors.InviteExpiredDataraise(e)excepterrors.UnprocessableEntityase:# handle e.data: errors.UnprocessableEntityDataraise(e)excepterrors.RateLimitExceededase:# handle e.data: errors.RateLimitExceededDataraise(e)excepterrors.InternalServerErrorase:# handle e.data: errors.InternalServerErrorDataraise(e)excepterrors.SDKErrorase:# handle exceptionraise(e)
The default server can be overridden globally by passing a URL to theserver_url: str optional parameter when initializing the SDK client instance. For example:
fromdubimportDubwithDub(server_url="https://api.dub.co",token="DUB_API_KEY",)asd_client:res=d_client.links.create(request={"url":"https://google.com","external_id":"123456","tag_ids": ["clux0rgak00011...", ], })assertresisnotNone# Handle responseprint(res)
The Python SDK makes API calls using thehttpx 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 ofHttpClient orAsyncHttpClient 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 ofhttpx.Client orhttpx.AsyncClient directly.
For example, you could specify a header for every request that this sdk makes as follows:
fromdubimportDubimporthttpxhttp_client=httpx.Client(headers={"x-custom-header":"someValue"})s=Dub(client=http_client)
or you could wrap the client with your own custom logic:
fromdubimportDubfromdub.httpclientimportAsyncHttpClientimporthttpxclassCustomClient(AsyncHttpClient):client:AsyncHttpClientdef__init__(self,client:AsyncHttpClient):self.client=clientasyncdefsend(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"returnawaitself.client.send(request,stream=stream,auth=auth,follow_redirects=follow_redirects )defbuild_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:returnself.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 thetoken parameter must be set when initializing the SDK client instance. For example:
fromdubimportDubwithDub(token="DUB_API_KEY",)asd_client:res=d_client.links.create(request={"url":"https://google.com","external_id":"123456","tag_ids": ["clux0rgak00011...", ], })assertresisnotNone# Handle responseprint(res)
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 aRetryConfig object to the call:
fromdubimportDubfromdub.utilsimportBackoffStrategy,RetryConfigwithDub(token="DUB_API_KEY",)asd_client:res=d_client.links.create(request={"url":"https://google.com","external_id":"123456","tag_ids": ["clux0rgak00011...", ], },RetryConfig("backoff",BackoffStrategy(1,50,1.1,100),False))assertresisnotNone# Handle responseprint(res)
If you'd like to override the default retry strategy for all operations that support retries, you can use theretry_config optional parameter when initializing the SDK:
fromdubimportDubfromdub.utilsimportBackoffStrategy,RetryConfigwithDub(retry_config=RetryConfig("backoff",BackoffStrategy(1,50,1.1,100),False),token="DUB_API_KEY",)asd_client:res=d_client.links.create(request={"url":"https://google.com","external_id":"123456","tag_ids": ["clux0rgak00011...", ], })assertresisnotNone# Handle responseprint(res)
Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but thereturned response object will have aNext method that can be called to pull down the next group of results. If thereturn value ofNext isNone, then there are no more pages to be fetched.
Here's an example of one such pagination call:
fromdubimportDubwithDub(token="DUB_API_KEY",)asd_client:res=d_client.links.list(request={})whileresisnotNone:# Handle itemsres=res.next()
TheDub class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via acontext manager and reuse it across the application.
fromdubimportDubdefmain():withDub(token="DUB_API_KEY", )asd_client:# Rest of application here...# Or when using async:asyncdefamain():asyncwithDub(token="DUB_API_KEY", )asd_client:# Rest of application here...
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.
fromdubimportDubimportlogginglogging.basicConfig(level=logging.DEBUG)s=Dub(debug_logger=logging.getLogger("dub"))
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.
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!