Skip to content

Commit ab53843

Browse files
DonDebonairFizzadar
authored andcommitted
docs: change recommended installation methods
1 parent 128d5d1 commit ab53843

File tree

3 files changed

+47
-5
lines changed

3 files changed

+47
-5
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@ Why pyinfra? Design features include:
3636

3737
## Quickstart
3838

39-
Install pyinfra with `pip`:
39+
Install pyinfra with [`uv`](https://docs.astral.sh/uv/):
4040

4141
```
42-
pip install pyinfra
42+
uv tool install pyinfra
4343
```
4444

4545
Now you can execute commands on hosts via SSH:

docs/getting-started.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
Getting Started
22
===============
33

4-
This guide should help describe the basics of deploying stuff with pyinfra. Start by installing pyinfra with ``pip`` (see :doc:`full install instructions <./install>`):
4+
This guide should help describe the basics of deploying stuff with pyinfra. Start by installing pyinfra with `uv <https://docs.astral.sh/uv/>`_ (see :doc:`full install instructions <./install>`):
55

66
.. code:: bash
77
8-
pip install pyinfra
8+
uv tool install pyinfra
99
1010
To do something with pyinfra you need two things:
1111

docs/install.md

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,49 @@ orphan: true
2626

2727
## Installation Method
2828

29-
### Using pip (Recommended)
29+
### Using uv (Recommended)
30+
31+
First install [uv](https://docs.astral.sh/uv/getting-started/installation/) if you haven't already.
32+
33+
Now you can install pyinfra as a tool, or add it to your project's dependencies.
34+
35+
#### Installing pyinfra as a tool
36+
37+
```sh
38+
# install pyinfra
39+
uv tool install pyinfra
40+
41+
# verify installation
42+
pyinfra --version
43+
```
44+
45+
#### Adding pyinfra to your project dependencies
46+
47+
```sh
48+
# add pyinfra to your project dependencies
49+
uv add pyinfra
50+
51+
# verify installation
52+
uv run pyinfra --version
53+
```
54+
55+
### Using pipx
56+
57+
First install [pipx](https://pipx.pypa.io/stable/installation/) if you haven't already.
58+
59+
#### Install pyinfra
60+
61+
```sh
62+
pipx install pyinfra
63+
```
64+
65+
#### Verify Installation
66+
67+
```sh
68+
pyinfra --version
69+
```
70+
71+
### Using pip
3072

3173
#### Create a Virtual Environment (Best Practice)
3274

0 commit comments

Comments
 (0)