You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+33-24Lines changed: 33 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,39 +43,56 @@ For comprehensive guides and API reference, visit our [full documentation](https
43
43
44
44
Tusk Drift currently supports the following packages and versions:
45
45
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`|
53
58
54
59
If you're using packages or versions not listed above, please create an issue with the package + version you'd like an instrumentation for.
55
60
56
61
## Installation
57
62
58
63
### Step 1: Install the CLI
59
64
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).
61
66
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
63
68
64
-
###Step 2: Install the SDK
69
+
#### AI-powered setup (recommended)
65
70
66
-
After completing the CLI wizard, install the SDK:
71
+
Use our AI agent to automatically set up Tusk Drift for your service:
67
72
68
73
```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
70
77
```
71
78
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.
73
80
74
-
Refer to our [initialization guide](docs/initialization.md) to set up the SDK for your service.
81
+
#### Manual setup
75
82
76
-
### Step 4: Run Your First Test
83
+
Alternatively, you can set up Tusk Drift manually:
77
84
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!
79
96
80
97
## Troubleshooting
81
98
@@ -87,11 +104,3 @@ Having issues?
87
104
## Community
88
105
89
106
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.
0 commit comments