Skip to content

python: update readme to say we are on pypi #146

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
npry merged 1 commit into from
Apr 27, 2026
Merged

python: update readme to say we are on pypi #146

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions ts_python/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,16 @@ $ TS_RS_EXPERIMENT=this_is_unstable_software python demo.py

## Building and Usage

We're not up on pypi, so you can't `pip install tailscale` yet. To use the module, you'll
need to build it. The best way to do that is with [`maturin`](https://www.maturin.rs/):
The easiest way to get the library is through pypi:

```shell
$ pip install tailscale
```

### In development

If you want to use the module from within this repo, you'll need to build it. The best way to do
that is with [`maturin`](https://www.maturin.rs/):

```sh
# In the project where you want to use the tailscale bindings:
Expand All @@ -55,4 +63,3 @@ $ maturin develop # build and install python bindings into your virt

$ python -c 'import tailscale' && echo "ready!" # bindings are available!
```