unkey.py

SDK Installation#

[!NOTE] > Python version upgrade policy

Once a Python version reaches its official 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 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 unkey.py

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

Shell and script usage with uv#

You can use this SDK in a Python shell with uv and the uvx command that comes with it like so:

uvx --from unkey.py 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 = [#     "unkey.py",# ]# ///from unkey.py import Unkeysdk = Unkey(  # SDK arguments)# Rest of script here...

Once that is saved to a file, you can run it with uv run script.py where script.py can be replaced with the actual file name.

SDK Example Usage#

Example#

# Synchronous Examplefrom unkey.py import Unkeywith Unkey(    root_key="<YOUR_BEARER_TOKEN_HERE>",) as unkey:    res = unkey.apis.create_api(name="payment-service-production")    # Handle response    print(res)

The same SDK client can also be used to make asynchronous requests by importing asyncio.

# Asynchronous Exampleimport asynciofrom unkey.py import Unkeyasync def main():    async with Unkey(        root_key="<YOUR_BEARER_TOKEN_HERE>",    ) as unkey:        res = await unkey.apis.create_api_async(name="payment-service-production")        # Handle response        print(res)asyncio.run(main())

Repository#