Python: Asynchronous client for the Tailscale API

Asynchronous client for the Tailscale API.

About

This package allows you to control and monitor Tailscale clients programmatically. It is mainly created to allow third-party programs to integrate with Tailscale.

Installation

uv pip install https://github.com/pythoninthegrasses/tailscale.git

Usage

import asyncio

from tailscale import Tailscale


async def main():
    """Show example on using the Tailscale API client."""
    async with Tailscale(
        tailnet="example",
        api_key="tskey-somethingsomething",
    ) as tailscale:

        devices = await tailscale.devices()
        print(devices)


if __name__ == "__main__":
    asyncio.run(main())

Changelog & Releases

This repository keeps a changelog using GitHub's releases functionality. The format of the log is based on Keep a Changelog.

Releases are based on Semantic Versioning, and use the format of MAJOR.MINOR.PATCH. In a nutshell, the version will be incremented based on the following:

• MAJOR: Incompatible or major changes.
• MINOR: Backwards-compatible new features and enhancements.
• PATCH: Backwards-compatible bugfixes and package updates.

Contributing

Thank you for being involved! 😍

Minimum Requirements

• Python 3.13+
• uv
• mise

To install all packages, including all development requirements:

# runtimes/tooling
mise install

# python virtual environment w/deps
uv sync --all-extras

Development

As this repository uses the prek framework, all changes are linted and tested with each commit. You can run all checks and tests manually, using the following command:

prek run --all-files

To run just the Python tests:

uv run pytest

Authors & contributors

The original setup of this repository is by Franck Nijhof.

License

MIT License