Skip to content

Commit a42b3b1

Browse files
committed
main readme
1 parent 0807445 commit a42b3b1

1 file changed

Lines changed: 25 additions & 6 deletions

File tree

README.md

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ A collection of small, independent Python utilities. Each tool is self-contained
77
| Tool | Description |
88
|------|-------------|
99
| [locust-compare](tools/locust-compare/) | Compare performance metrics between two Locust runs |
10+
| [config-utils](tools/config-utils/) | CLI tool for capturing environment variables and Django settings |
1011

1112
## Installation
1213

@@ -16,18 +17,28 @@ Each tool can be installed independently using `uvx` directly from GitHub:
1617

1718
For example:
1819
```bash
20+
# Install locust-compare
1921
uv tool install 'git+https://github.com/dev-ankit/python-tools.git#subdirectory=tools/locust-compare'
22+
23+
# Install config-utils
24+
uv tool install 'git+https://github.com/dev-ankit/python-tools.git#subdirectory=tools/config-utils'
2025
```
21-
After that, you can run from anywhere:
26+
27+
After installation, you can run from anywhere:
28+
```bash
2229
locust-compare <base_dir> <current_dir>
30+
config-utils capture-env
31+
```
2332

2433
To update to the latest from GitHub:
2534

26-
```
35+
```bash
2736
uv tool upgrade locust-compare
37+
uv tool upgrade config-utils
2838

2939
# Or force reinstall:
3040
uv tool install --force 'git+https://github.com/dev-ankit/python-tools.git#subdirectory=tools/locust-compare'
41+
uv tool install --force 'git+https://github.com/dev-ankit/python-tools.git#subdirectory=tools/config-utils'
3142

3243
# To see installed tools:
3344
uv tool list
@@ -42,7 +53,11 @@ uvx --from 'git+https://github.com/dev-ankit/python-tools.git#subdirectory=tools
4253
For example:
4354

4455
```bash
56+
# Run locust-compare
4557
uvx --from 'git+https://github.com/dev-ankit/python-tools.git#subdirectory=tools/locust-compare' locust-compare <base_dir> <current_dir>
58+
59+
# Run config-utils
60+
uvx --from 'git+https://github.com/dev-ankit/python-tools.git#subdirectory=tools/config-utils' config-utils capture-env
4661
```
4762

4863
Option 3: Clone and run locally:
@@ -62,11 +77,15 @@ python-tools/
6277
├── .github/
6378
│ └── workflows/
6479
└── tools/
65-
└── locust-compare/ # Locust performance comparison tool
66-
├── compare_runs.py
80+
├── locust-compare/ # Locust performance comparison tool
81+
│ ├── compare_runs.py
82+
│ ├── pyproject.toml
83+
│ ├── README.md
84+
│ └── tests/
85+
└── config-utils/ # CLI tool for capturing environment variables and Django settings
86+
├── cli.py
6787
├── pyproject.toml
68-
├── README.md
69-
└── tests/
88+
└── README.md
7089
```
7190

7291
## Adding a New Tool

0 commit comments

Comments
 (0)