Skip to content

Commit cbe39fc

Browse files
committed
feat: enhance installation documentation with additional package manager support
1 parent faddb23 commit cbe39fc

File tree

1 file changed

+98
-26
lines changed

1 file changed

+98
-26
lines changed

docs/docs/installation.md

Lines changed: 98 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,35 @@
11
# Installation
22

3-
TPPT can be installed using pip or your favorite Python package manager.
3+
TPPT can be installed using your favorite Python package manager.
44

55
## Requirements
66

77
- Python 3.11 or higher
8-
- pip or uv package manager
9-
10-
## Using pip
11-
12-
```bash
13-
pip install tppt
14-
```
15-
16-
## Using uv
17-
18-
```bash
19-
uv pip install tppt
20-
```
8+
- One of the following package managers:
9+
- pip
10+
- uv
11+
- hatch
12+
- poetry
13+
14+
=== "pip"
15+
```bash
16+
pip install tppt
17+
```
18+
19+
=== "uv"
20+
```bash
21+
uv add tppt
22+
```
23+
24+
=== "hatch"
25+
```bash
26+
hatch add tppt
27+
```
28+
29+
=== "poetry"
30+
```bash
31+
poetry add tppt
32+
```
2133

2234
## Optional Dependencies
2335

@@ -27,29 +39,89 @@ TPPT provides optional dependencies for additional features:
2739

2840
For working with data frames:
2941

30-
```bash
31-
# For pandas support
32-
uv pip install "tppt[pandas]"
42+
=== "pip"
43+
```bash
44+
# For pandas support
45+
pip install "tppt[pandas]"
46+
47+
# For polars support
48+
pip install "tppt[polars]"
49+
```
50+
51+
=== "uv"
52+
```bash
53+
# For pandas support
54+
uv add "tppt[pandas]"
55+
56+
# For polars support
57+
uv add "tppt[polars]"
58+
```
3359

34-
# For polars support
35-
uv pip install "tppt[polars]"
36-
```
60+
=== "hatch"
61+
```bash
62+
# For pandas support
63+
hatch add "tppt[pandas]"
64+
65+
# For polars support
66+
hatch add "tppt[polars]"
67+
```
68+
69+
=== "poetry"
70+
```bash
71+
# For pandas support
72+
poetry add "tppt[pandas]"
73+
74+
# For polars support
75+
poetry add "tppt[polars]"
76+
```
3777

3878
### Pydantic Support
3979

4080
For Pydantic integration:
4181

42-
```bash
43-
uv pip install "tppt[pydantic]"
44-
```
82+
=== "pip"
83+
```bash
84+
pip install "tppt[pydantic]"
85+
```
86+
87+
=== "uv"
88+
```bash
89+
uv add "tppt[pydantic]"
90+
```
91+
92+
=== "hatch"
93+
```bash
94+
hatch add "tppt[pydantic]"
95+
```
96+
97+
=== "poetry"
98+
```bash
99+
poetry add "tppt[pydantic]"
100+
```
45101

46102
### Development Tools
47103

48104
For development purposes:
49105

50-
```bash
51-
uv pip install "tppt[dev]"
52-
```
106+
=== "pip"
107+
```bash
108+
pip install "tppt[dev]"
109+
```
110+
111+
=== "uv"
112+
```bash
113+
uv add "tppt[dev]"
114+
```
115+
116+
=== "hatch"
117+
```bash
118+
hatch add "tppt[dev]"
119+
```
120+
121+
=== "poetry"
122+
```bash
123+
poetry add "tppt[dev]"
124+
```
53125

54126
## Verifying Installation
55127

0 commit comments

Comments
 (0)