dubinc/dub-python

Official Dub Python SDK

Dub.co Python SDK

Learn more about the Dub.co Python SDK in the official documentation.

Summary

Dub.co API: Dub is link management infrastructure for companies to create marketing campaigns, link sharing features, and referral programs.

Table of Contents

• SDK Installation
• SDK Example Usage
• Available Resources and Operations
• Error Handling
• Server Selection
• Custom HTTP Client
• Authentication
• Retries
• Pagination
• Debugging
• IDE Support
• Development
  • Contributions

SDK Installation

The SDK can be installed with either pip or poetry package managers.

PIP

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

Poetry 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 dub

SDK Example Usage

Example 1

# Synchronous Example
from dub import Dub

with Dub(
    token="DUB_API_KEY",
) as s:
    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():
    async with Dub(
        token="DUB_API_KEY",
    ) as s:
        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())

Example 2

# Synchronous Example
from dub import Dub

with Dub(
    token="DUB_API_KEY",
) as s:
    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():
    async with Dub(
        token="DUB_API_KEY",
    ) as s:
        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())

Available Resources and Operations

Available methods

analytics

• retrieve - Retrieve analytics for a link, a domain, or the authenticated workspace.

customers

• list - Retrieve a list of customers
• create - Create a customer
• get - Retrieve a customer
• update - Update a customer
• delete - Delete a customer

domains

• create - Create a domain
• list - Retrieve a list of domains
• update - Update a domain
• delete - Delete a domain

embed_tokens

• create - Create a new embed token

events

• list - Retrieve a list of events

links

• 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

metatags

• get - Retrieve the metatags for a URL

qr_codes

• get - Retrieve a QR code

tags

• create - Create a new tag
• list - Retrieve a list of tags
• update - Update a tag
• delete - Delete a tag

track

• lead - Track a lead
• sale - Track a sale
• customer - Track a customer ⚠️ Deprecated

workspaces

• get - Retrieve a workspace
• update - Update a workspace

Error Handling

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 respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the create_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	*/*

Example

from dub import Dub
from dub.models import errors

with Dub(
    token="DUB_API_KEY",
) as s:
    res = None
    try:
        res = s.links.create(request={
            "url": "https://google.com",
            "external_id": "123456",
            "tag_ids": [
                "clux0rgak00011...",
            ],
        })

        if res is not None:
            # handle response
            pass

    except errors.BadRequest as e:
        # handle e.data: errors.BadRequestData
        raise(e)
    except errors.Unauthorized as e:
        # handle e.data: errors.UnauthorizedData
        raise(e)
    except errors.Forbidden as e:
        # handle e.data: errors.ForbiddenData
        raise(e)
    except errors.NotFound as e:
        # handle e.data: errors.NotFoundData
        raise(e)
    except errors.Conflict as e:
        # handle e.data: errors.ConflictData
        raise(e)
    except errors.InviteExpired as e:
        # handle e.data: errors.InviteExpiredData
        raise(e)
    except errors.UnprocessableEntity as e:
        # handle e.data: errors.UnprocessableEntityData
        raise(e)
    except errors.RateLimitExceeded as e:
        # handle e.data: errors.RateLimitExceededData
        raise(e)
    except errors.InternalServerError as e:
        # handle e.data: errors.InternalServerErrorData
        raise(e)
    except errors.SDKError as e:
        # handle exception
        raise(e)

Server Selection

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:

from dub import Dub

with Dub(
    server_url="https://api.dub.co",
    token="DUB_API_KEY",
) as s:
    res = s.links.create(request={
        "url": "https://google.com",
        "external_id": "123456",
        "tag_ids": [
            "clux0rgak00011...",
        ],
    })

    if res is not None:
        # handle response
        pass

Custom HTTP Client

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()))

Authentication

Per-Client Security Schemes

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

with Dub(
    token="DUB_API_KEY",
) as s:
    res = s.links.create(request={
        "url": "https://google.com",
        "external_id": "123456",
        "tag_ids": [
            "clux0rgak00011...",
        ],
    })

    if res is not None:
        # handle response
        pass

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:

from dub import Dub
from dub.utils import BackoffStrategy, RetryConfig

with Dub(
    token="DUB_API_KEY",
) as s:
    res = s.links.create(request={
        "url": "https://google.com",
        "external_id": "123456",
        "tag_ids": [
            "clux0rgak00011...",
        ],
    },
        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:

from dub import Dub
from dub.utils import BackoffStrategy, RetryConfig

with Dub(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
    token="DUB_API_KEY",
) as s:
    res = s.links.create(request={
        "url": "https://google.com",
        "external_id": "123456",
        "tag_ids": [
            "clux0rgak00011...",
        ],
    })

    if res is not None:
        # handle response
        pass

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will have a Next method that can be called to pull down the next group of results. If the return value of Next is None, then there are no more pages to be fetched.

Here's an example of one such pagination call:

from dub import Dub

with Dub(
    token="DUB_API_KEY",
) as s:
    res = s.links.list(request={
        "page": 1,
        "page_size": 50,
    })

    if res is not None:
        while True:
            # handle items

            res = res.next()
            if res is None:
                break

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.

from dub import Dub
import logging

logging.basicConfig(level=logging.DEBUG)
s = Dub(debug_logger=logging.getLogger("dub"))

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

Development

Contributions

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!

SDK Created by Speakeasy