Skip to content

Commit 4493428

Browse files
committed
feat: update installation documentation to include package manager commands and improve clarity
1 parent 0f36e63 commit 4493428

File tree

1 file changed

+35
-35
lines changed

1 file changed

+35
-35
lines changed

docs/docs/installation.md

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -6,31 +6,31 @@ TPPT can be installed using your favorite Python package manager.
66

77
- Python 3.11 or higher
88
- One of the following package managers:
9+
* [pip](https://pip.pypa.io/)
910
* [uv](https://docs.astral.sh/uv/)
10-
* [poetry](https://python-poetry.org/)
1111
* [hatch](https://hatch.pypa.io/)
12-
* [pip](https://pip.pypa.io/)
13-
14-
=== "uv"
15-
```bash
16-
uv add tppt
17-
```
12+
* [poetry](https://python-poetry.org/)
1813

1914
=== "pip"
2015
```bash
2116
pip install tppt
2217
```
2318

24-
=== "poetry"
19+
=== "uv"
2520
```bash
26-
poetry add tppt
21+
uv add tppt
2722
```
2823

2924
=== "hatch"
3025
```bash
3126
hatch add tppt
3227
```
3328

29+
=== "poetry"
30+
```bash
31+
poetry add tppt
32+
```
33+
3434
## Optional Dependencies
3535

3636
TPPT provides optional dependencies for additional features:
@@ -39,15 +39,6 @@ TPPT provides optional dependencies for additional features:
3939

4040
For working with data frames:
4141

42-
=== "uv"
43-
```bash
44-
# For pandas support
45-
uv add "tppt[pandas]"
46-
47-
# For polars support
48-
uv add "tppt[polars]"
49-
```
50-
5142
=== "pip"
5243
```bash
5344
# For pandas support
@@ -57,13 +48,13 @@ For working with data frames:
5748
pip install "tppt[polars]"
5849
```
5950

60-
=== "poetry"
51+
=== "uv"
6152
```bash
6253
# For pandas support
63-
poetry add "tppt[pandas]"
54+
uv add "tppt[pandas]"
6455

6556
# For polars support
66-
poetry add "tppt[polars]"
57+
uv add "tppt[polars]"
6758
```
6859

6960
=== "hatch"
@@ -75,54 +66,63 @@ For working with data frames:
7566
hatch add "tppt[polars]"
7667
```
7768

69+
=== "poetry"
70+
```bash
71+
# For pandas support
72+
poetry add "tppt[pandas]"
73+
74+
# For polars support
75+
poetry add "tppt[polars]"
76+
```
77+
7878
### Pydantic Support
7979

8080
For Pydantic integration:
8181

82-
=== "uv"
83-
```bash
84-
uv add "tppt[pydantic]"
85-
```
86-
8782
=== "pip"
8883
```bash
8984
pip install "tppt[pydantic]"
9085
```
9186

92-
=== "poetry"
87+
=== "uv"
9388
```bash
94-
poetry add "tppt[pydantic]"
89+
uv add "tppt[pydantic]"
9590
```
9691

9792
=== "hatch"
9893
```bash
9994
hatch add "tppt[pydantic]"
10095
```
10196

97+
=== "poetry"
98+
```bash
99+
poetry add "tppt[pydantic]"
100+
```
101+
102102
### Development Tools
103103

104104
For development purposes:
105105

106-
=== "uv"
107-
```bash
108-
uv add "tppt[dev]"
109-
```
110-
111106
=== "pip"
112107
```bash
113108
pip install "tppt[dev]"
114109
```
115110

116-
=== "poetry"
111+
=== "uv"
117112
```bash
118-
poetry add "tppt[dev]"
113+
uv add "tppt[dev]"
119114
```
120115

121116
=== "hatch"
122117
```bash
123118
hatch add "tppt[dev]"
124119
```
125120

121+
=== "poetry"
122+
```bash
123+
poetry add "tppt[dev]"
124+
```
125+
126126
## Verifying Installation
127127

128128
You can verify the installation by running:

0 commit comments

Comments
 (0)