Skip to content

Commit 759bf41

Browse files
authored
chore: update docs (#38)
1 parent 921352f commit 759bf41

File tree

3 files changed

+39
-26
lines changed

3 files changed

+39
-26
lines changed

README.md

Lines changed: 33 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -43,39 +43,56 @@ For comprehensive guides and API reference, visit our [full documentation](https
4343

4444
Tusk Drift currently supports the following packages and versions:
4545

46-
- **Flask**: `flask>=2.0.0`
47-
- **FastAPI**: `fastapi>=0.68.0`
48-
- **Django**: `django>=3.2.0`
49-
- **Requests**: `requests` (all versions)
50-
- **HTTPX**: `httpx` (all versions)
51-
- **psycopg**: `psycopg>=3.0.0`, `psycopg2>=2.8.0`
52-
- **Redis**: `redis` (all versions)
46+
| Package | Supported Versions |
47+
|---------|-------------------|
48+
| Flask | `>=2.0.0` |
49+
| FastAPI | `>=0.68.0` |
50+
| Django | `>=3.2.0` |
51+
| Requests | all versions |
52+
| HTTPX | all versions |
53+
| aiohttp | all versions |
54+
| urllib3 | all versions |
55+
| psycopg | `>=3.1.12` |
56+
| psycopg2 | all versions |
57+
| Redis | `>=4.0.0` |
5358

5459
If you're using packages or versions not listed above, please create an issue with the package + version you'd like an instrumentation for.
5560

5661
## Installation
5762

5863
### Step 1: Install the CLI
5964

60-
First, install and configure the Tusk Drift CLI by following our [CLI installation guide](https://github.com/Use-Tusk/tusk-drift-cli?tab=readme-ov-file#install). The CLI helps set up your Tusk configuration file and replays tests.
65+
First, install the Tusk Drift CLI by following our [CLI installation guide](https://github.com/Use-Tusk/tusk-drift-cli?tab=readme-ov-file#install).
6166

62-
The wizard will eventually direct you back here when it's time to set up the SDK.
67+
### Step 2: Set up Tusk Drift
6368

64-
### Step 2: Install the SDK
69+
#### AI-powered setup (recommended)
6570

66-
After completing the CLI wizard, install the SDK:
71+
Use our AI agent to automatically set up Tusk Drift for your service:
6772

6873
```bash
69-
pip install tusk-drift-python-sdk
74+
cd path/to/your/service
75+
export ANTHROPIC_API_KEY=your-api-key
76+
tusk setup
7077
```
7178

72-
### Step 3: Initialize the SDK for your service
79+
The agent will analyze your codebase, install the SDK, instrument it into your application, create configuration files, and test the setup with recording and replay.
7380

74-
Refer to our [initialization guide](docs/initialization.md) to set up the SDK for your service.
81+
#### Manual setup
7582

76-
### Step 4: Run Your First Test
83+
Alternatively, you can set up Tusk Drift manually:
7784

78-
Follow along our [quick start guide](docs/quickstart.md) to record and replay your first test!
85+
1. Install the SDK:
86+
87+
```bash
88+
pip install tusk-drift-python-sdk
89+
```
90+
91+
2. Create configuration: Run `tusk init` to create your `.tusk/config.yaml` config file interactively, or create it manually per the [configuration docs](https://github.com/Use-Tusk/tusk-drift-cli/blob/main/docs/configuration.md).
92+
93+
3. Initialize the SDK: Refer to the [initialization guide](docs/initialization.md) to instrument the SDK in your service.
94+
95+
4. Record and replay: Follow the [quick start guide](docs/quickstart.md) to record and replay your first test!
7996

8097
## Troubleshooting
8198

@@ -87,11 +104,3 @@ Having issues?
87104
## Community
88105

89106
Join our open source community on [Slack](https://join.slack.com/t/tusk-community/shared_invite/zt-3fve1s7ie-NAAUn~UpHsf1m_2tdoGjsQ).
90-
91-
## Contributing
92-
93-
We appreciate feedback and contributions. See [CONTRIBUTING.md](/CONTRIBUTING.md).
94-
95-
## License
96-
97-
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.

docs/initialization.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,13 @@
44

55
Before setting up the SDK, ensure you have:
66

7-
- Completed the [CLI wizard](https://github.com/Use-Tusk/tusk-drift-cli?tab=readme-ov-file#quick-start)
7+
- Python 3.9 or later installed
8+
- Installed the [Tusk Drift CLI](https://github.com/Use-Tusk/tusk-drift-cli?tab=readme-ov-file#install)
89
- Obtained an API key from the [Tusk Drift dashboard](https://usetusk.ai/app/settings/api-keys) (only required if using Tusk Cloud)
9-
- Python 3.12 or later installed
10+
11+
> [!TIP]
12+
> For automated setup, use `tusk setup` which handles SDK installation and initialization for you.
13+
> The steps below are for manual setup.
1014
1115
## Step 1: Install the SDK
1216

images/tusk-banner.png

-25 KB
Loading

0 commit comments

Comments
 (0)