Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Official Dub Python SDK

License

NotificationsYou must be signed in to change notification settings

dubinc/dub-python

Repository files navigation

Dub.co Python SDK to interact with APIs.

Dub.co Python SDK


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

Summary

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

Table of Contents

SDK Installation

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

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 singlepyproject.toml file to handle project metadata and dependencies.

poetry add dub

Shell and script usage withuv

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.

SDK Example Usage

Example 1

# Synchronous ExamplefromdubimportDubwithDub(token="DUB_API_KEY",)asd_client:res=d_client.links.create(request={"url":"https://google.com","external_id":"123456","tag_ids": ["clux0rgak00011...",        ],"test_variants": [            {"url":"https://example.com/variant-1","percentage":50,            },            {"url":"https://example.com/variant-2","percentage":50,            },        ],    })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...",            ],"test_variants": [                {"url":"https://example.com/variant-1","percentage":50,                },                {"url":"https://example.com/variant-2","percentage":50,                },            ],        })assertresisnotNone# Handle responseprint(res)asyncio.run(main())

Example 2

# Synchronous ExamplefromdubimportDubwithDub(token="DUB_API_KEY",)asd_client:res=d_client.links.upsert(request={"url":"https://google.com","external_id":"123456","tag_ids": ["clux0rgak00011...",        ],"test_variants": [            {"url":"https://example.com/variant-1","percentage":50,            },            {"url":"https://example.com/variant-2","percentage":50,            },        ],    })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...",            ],"test_variants": [                {"url":"https://example.com/variant-1","percentage":50,                },                {"url":"https://example.com/variant-2","percentage":50,                },            ],        })assertresisnotNone# Handle responseprint(res)asyncio.run(main())

Available Resources and Operations

Available methods
  • retrieve - Retrieve analytics for a link, a domain, or the authenticated workspace.
  • list - Get commissions for a program.
  • update - Update a commission.
  • list - Retrieve a list of customers
  • create - Create a customer⚠️Deprecated
  • get - Retrieve a customer
  • update - Update a customer
  • delete - Delete a customer
  • list - Retrieve a list of events
  • get - Retrieve a QR code
  • get - Retrieve a workspace
  • update - Update a workspace

Error Handling

DubError is the base class for all HTTP error responses. It has the following properties:

PropertyTypeDescription
err.messagestrError message
err.status_codeintHTTP response status code eg404
err.headershttpx.HeadersHTTP response headers
err.bodystrHTTP body. Can be empty string if no body is returned.
err.raw_responsehttpx.ResponseRaw HTTP response
err.dataOptional. Some errors may contain structured data.See Error Classes.

Example

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...",            ],"test_variants": [                {"url":"https://example.com/variant-1","percentage":50,                },                {"url":"https://example.com/variant-2","percentage":50,                },            ],        })assertresisnotNone# Handle responseprint(res)excepterrors.DubErrorase:# The base class for HTTP error responsesprint(e.message)print(e.status_code)print(e.body)print(e.headers)print(e.raw_response)# Depending on the method different errors may be thrownifisinstance(e,errors.BadRequest):print(e.data.error)# errors.Error

Error Classes

Primary errors:

  • DubError: The base class for HTTP error responses.
    • BadRequest: The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). Status code400.
    • Unauthorized: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. Status code401.
    • Forbidden: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server. Status code403.
    • NotFound: The server cannot find the requested resource. Status code404.
    • Conflict: This response is sent when a request conflicts with the current state of the server. Status code409.
    • InviteExpired: This response is sent when the requested content has been permanently deleted from server, with no forwarding address. Status code410.
    • UnprocessableEntity: The request was well-formed but was unable to be followed due to semantic errors. Status code422.
    • RateLimitExceeded: The user has sent too many requests in a given amount of time ("rate limiting"). Status code429.
    • InternalServerError: The server has encountered a situation it does not know how to handle. Status code500.
Less common errors (5)

Network errors:

Inherit fromDubError:

  • ResponseValidationError: Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via thecause attribute.

Server Selection

Override Server URL Per-Client

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...",        ],"test_variants": [            {"url":"https://example.com/variant-1","percentage":50,            },            {"url":"https://example.com/variant-2","percentage":50,            },        ],    })assertresisnotNone# Handle responseprint(res)

Custom HTTP Client

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

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

NameTypeScheme
tokenhttpHTTP 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...",        ],"test_variants": [            {"url":"https://example.com/variant-1","percentage":50,            },            {"url":"https://example.com/variant-2","percentage":50,            },        ],    })assertresisnotNone# Handle responseprint(res)

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 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...",        ],"test_variants": [            {"url":"https://example.com/variant-1","percentage":50,            },            {"url":"https://example.com/variant-2","percentage":50,            },        ],    },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...",        ],"test_variants": [            {"url":"https://example.com/variant-1","percentage":50,            },            {"url":"https://example.com/variant-2","percentage":50,            },        ],    })assertresisnotNone# Handle responseprint(res)

Pagination

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={"page_size":50,    })whileresisnotNone:# Handle itemsres=res.next()

Resource Management

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...

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.

fromdubimportDubimportlogginglogging.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.

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 bySpeakeasy

About

Official Dub Python SDK

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors6

Languages

[8]ページ先頭
©2009-2025 Movatter.jp