# Python: Asynchronous client for the Tailscale API
[![GitHub Release][releases-shield]][releases]
[![Python Versions][python-versions-shield]][pypi]
![Project Stage][project-stage-shield]
![Project Maintenance][maintenance-shield]
[![License][license-shield]](LICENSE.md)
[![Build Status][build-shield]][build]
[![Code Coverage][codecov-shield]][codecov]
[![Code Quality][code-quality-shield]][code-quality]
[![Sponsor Frenck via GitHub Sponsors][github-sponsors-shield]][github-sponsors]
[![Support Frenck on Patreon][patreon-shield]][patreon]
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
```bash
pip install tailscale
```
## Usage
```python
import asyncio
from tailscale import Tailscale
async def main():
"""Show example on using the Tailscale API client."""
async with Tailscale(
tailnet="frenck",
api_key="tskey-somethingsomething",
) as tailscale:
devices = await tailscale.devices()
print(devices)
if __name__ == "__main__":
asyncio.run(main())
```
## Changelog & Releases
This repository keeps a change log using [GitHub's releases][releases]
functionality. The format of the log is based on
[Keep a Changelog][keepchangelog].
Releases are based on [Semantic Versioning][semver], 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
This is an active open-source project. We are always open to people who want to
use the code or contribute to it.
We've set up a separate document for our
[contribution guidelines](.github/CONTRIBUTING.md).
Thank you for being involved! :heart_eyes:
## Setting up development environment
This Python project is fully managed using the [Poetry][poetry] dependency
manager. But also relies on the use of NodeJS for certain checks during
development.
You need at least:
- Python 3.9+
- [Poetry][poetry-install]
- NodeJS 14+ (including NPM)
To install all packages, including all development requirements:
```bash
npm install
poetry install
```
As this repository uses the [pre-commit][pre-commit] framework, all changes
are linted and tested with each commit. You can run all checks and tests
manually, using the following command:
```bash
poetry run pre-commit run --all-files
```
To run just the Python tests:
```bash
poetry run pytest
```
## Authors & contributors
The original setup of this repository is by [Franck Nijhof][frenck].
For a full list of all authors and contributors,
check [the contributor's page][contributors].
## License
MIT License
Copyright (c) 2021 Franck Nijhof
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
[build-shield]: https://github.com/frenck/python-tailscale/actions/workflows/tests.yaml/badge.svg
[build]: https://github.com/frenck/python-tailscale/actions/workflows/tests.yaml
[code-quality-shield]: https://img.shields.io/lgtm/grade/python/g/frenck/python-tailscale.svg?logo=lgtm&logoWidth=18
[code-quality]: https://lgtm.com/projects/g/frenck/python-tailscale/context:python
[codecov-shield]: https://codecov.io/gh/frenck/python-tailscale/branch/master/graph/badge.svg
[codecov]: https://codecov.io/gh/frenck/python-tailscale
[contributors]: https://github.com/frenck/python-tailscale/graphs/contributors
[frenck]: https://github.com/frenck
[github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png
[github-sponsors]: https://github.com/sponsors/frenck
[keepchangelog]: https://keepachangelog.com/en/1.0.0/
[license-shield]: https://img.shields.io/github/license/frenck/python-tailscale.svg
[maintenance-shield]: https://img.shields.io/maintenance/yes/2021.svg
[patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png
[patreon]: https://www.patreon.com/frenck
[poetry-install]: https://python-poetry.org/docs/#installation
[poetry]: https://python-poetry.org
[pre-commit]: https://pre-commit.com/
[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg
[pypi]: https://pypi.org/project/tailscale/
[python-versions-shield]: https://img.shields.io/pypi/pyversions/tailscale
[releases-shield]: https://img.shields.io/github/release/frenck/python-tailscale.svg
[releases]: https://github.com/frenck/python-tailscale/releases
[semver]: https://semver.org/spec/v2.0.0.html
Raw data
{
"_id": null,
"home_page": "https://github.com/offbyone/python-tailscale",
"name": "tailscale-nuevo",
"maintainer": "Chris Rose",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "offline@offby1.net",
"keywords": "tailscale,vpn,wireguard,api,async,client",
"author": "Franck Nijhof",
"author_email": "opensource@frenck.dev",
"download_url": "https://files.pythonhosted.org/packages/fe/e5/759ed1e589cd925e68f595196035958bdd586918f72b09d22e4454d27bb4/tailscale_nuevo-1.0.0.tar.gz",
"platform": null,
"description": "# Python: Asynchronous client for the Tailscale API\n\n[![GitHub Release][releases-shield]][releases]\n[![Python Versions][python-versions-shield]][pypi]\n![Project Stage][project-stage-shield]\n![Project Maintenance][maintenance-shield]\n[![License][license-shield]](LICENSE.md)\n\n[![Build Status][build-shield]][build]\n[![Code Coverage][codecov-shield]][codecov]\n[![Code Quality][code-quality-shield]][code-quality]\n\n[![Sponsor Frenck via GitHub Sponsors][github-sponsors-shield]][github-sponsors]\n\n[![Support Frenck on Patreon][patreon-shield]][patreon]\n\nAsynchronous client for the Tailscale API.\n\n## About\n\nThis package allows you to control and monitor Tailscale clients\nprogrammatically. It is mainly created to allow third-party programs to\nintegrate with Tailscale.\n\n## Installation\n\n```bash\npip install tailscale\n```\n\n## Usage\n\n```python\nimport asyncio\n\nfrom tailscale import Tailscale\n\n\nasync def main():\n \"\"\"Show example on using the Tailscale API client.\"\"\"\n async with Tailscale(\n tailnet=\"frenck\",\n api_key=\"tskey-somethingsomething\",\n ) as tailscale:\n\n devices = await tailscale.devices()\n print(devices)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n```\n\n## Changelog & Releases\n\nThis repository keeps a change log using [GitHub's releases][releases]\nfunctionality. The format of the log is based on\n[Keep a Changelog][keepchangelog].\n\nReleases are based on [Semantic Versioning][semver], and use the format\nof `MAJOR.MINOR.PATCH`. In a nutshell, the version will be incremented\nbased on the following:\n\n- `MAJOR`: Incompatible or major changes.\n- `MINOR`: Backwards-compatible new features and enhancements.\n- `PATCH`: Backwards-compatible bugfixes and package updates.\n\n## Contributing\n\nThis is an active open-source project. We are always open to people who want to\nuse the code or contribute to it.\n\nWe've set up a separate document for our\n[contribution guidelines](.github/CONTRIBUTING.md).\n\nThank you for being involved! :heart_eyes:\n\n## Setting up development environment\n\nThis Python project is fully managed using the [Poetry][poetry] dependency\nmanager. But also relies on the use of NodeJS for certain checks during\ndevelopment.\n\nYou need at least:\n\n- Python 3.9+\n- [Poetry][poetry-install]\n- NodeJS 14+ (including NPM)\n\nTo install all packages, including all development requirements:\n\n```bash\nnpm install\npoetry install\n```\n\nAs this repository uses the [pre-commit][pre-commit] framework, all changes\nare linted and tested with each commit. You can run all checks and tests\nmanually, using the following command:\n\n```bash\npoetry run pre-commit run --all-files\n```\n\nTo run just the Python tests:\n\n```bash\npoetry run pytest\n```\n\n## Authors & contributors\n\nThe original setup of this repository is by [Franck Nijhof][frenck].\n\nFor a full list of all authors and contributors,\ncheck [the contributor's page][contributors].\n\n## License\n\nMIT License\n\nCopyright (c) 2021 Franck Nijhof\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n[build-shield]: https://github.com/frenck/python-tailscale/actions/workflows/tests.yaml/badge.svg\n[build]: https://github.com/frenck/python-tailscale/actions/workflows/tests.yaml\n[code-quality-shield]: https://img.shields.io/lgtm/grade/python/g/frenck/python-tailscale.svg?logo=lgtm&logoWidth=18\n[code-quality]: https://lgtm.com/projects/g/frenck/python-tailscale/context:python\n[codecov-shield]: https://codecov.io/gh/frenck/python-tailscale/branch/master/graph/badge.svg\n[codecov]: https://codecov.io/gh/frenck/python-tailscale\n[contributors]: https://github.com/frenck/python-tailscale/graphs/contributors\n[frenck]: https://github.com/frenck\n[github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png\n[github-sponsors]: https://github.com/sponsors/frenck\n[keepchangelog]: https://keepachangelog.com/en/1.0.0/\n[license-shield]: https://img.shields.io/github/license/frenck/python-tailscale.svg\n[maintenance-shield]: https://img.shields.io/maintenance/yes/2021.svg\n[patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png\n[patreon]: https://www.patreon.com/frenck\n[poetry-install]: https://python-poetry.org/docs/#installation\n[poetry]: https://python-poetry.org\n[pre-commit]: https://pre-commit.com/\n[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg\n[pypi]: https://pypi.org/project/tailscale/\n[python-versions-shield]: https://img.shields.io/pypi/pyversions/tailscale\n[releases-shield]: https://img.shields.io/github/release/frenck/python-tailscale.svg\n[releases]: https://github.com/frenck/python-tailscale/releases\n[semver]: https://semver.org/spec/v2.0.0.html\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Asynchronous client for the Tailscale API.",
"version": "1.0.0",
"project_urls": {
"Bug Tracker": "https://github.com/offbyone/python-tailscale/issues",
"Changelog": "https://github.com/offbyone/python-tailscale/releases",
"Documentation": "https://github.com/offbyone/python-tailscale",
"Homepage": "https://github.com/offbyone/python-tailscale",
"Repository": "https://github.com/offbyone/python-tailscale"
},
"split_keywords": [
"tailscale",
"vpn",
"wireguard",
"api",
"async",
"client"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "79a48a13e8b26c88d7017099381ee3dde21b1326c36b2646009de3bfb67e018e",
"md5": "291d160988b3b976b2c1031f797fdfe5",
"sha256": "07568facdea7c32b14d3ef70c226f224f37579ec3f70004c7a038d2126b80cc9"
},
"downloads": -1,
"filename": "tailscale_nuevo-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "291d160988b3b976b2c1031f797fdfe5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 7770,
"upload_time": "2023-11-04T18:12:11",
"upload_time_iso_8601": "2023-11-04T18:12:11.515088Z",
"url": "https://files.pythonhosted.org/packages/79/a4/8a13e8b26c88d7017099381ee3dde21b1326c36b2646009de3bfb67e018e/tailscale_nuevo-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fee5759ed1e589cd925e68f595196035958bdd586918f72b09d22e4454d27bb4",
"md5": "8650bca6751d7ce434b0d248f12f2373",
"sha256": "c0b997fed556bda37c7d518b5217456fc2fd48725d6a90adf16f98ecfc24b92c"
},
"downloads": -1,
"filename": "tailscale_nuevo-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "8650bca6751d7ce434b0d248f12f2373",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 7114,
"upload_time": "2023-11-04T18:12:13",
"upload_time_iso_8601": "2023-11-04T18:12:13.298785Z",
"url": "https://files.pythonhosted.org/packages/fe/e5/759ed1e589cd925e68f595196035958bdd586918f72b09d22e4454d27bb4/tailscale_nuevo-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-04 18:12:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "offbyone",
"github_project": "python-tailscale",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "tailscale-nuevo"
}
JSON
