forked from getsentry/sentry-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathquick-reference.mdc
More file actions
51 lines (37 loc) · 982 Bytes
/
Copy pathquick-reference.mdc
File metadata and controls
51 lines (37 loc) · 982 Bytes
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
---
description:
globs:
alwaysApply: false
---
# Quick Reference
## Common Commands
### Development Setup
```bash
make .venv
source .venv/bin/activate # Windows: .venv\Scripts\activate
```
### Testing
Our test matrix is implemented in [tox](mdc:https://tox.wiki).
The following runs the whole test suite and takes a long time.
```bash
source .venv/bin/activate
tox
```
Prefer testing a single environment instead while developing.
```bash
tox -e py3.12-common
```
For running a single test, use the pattern:
```bash
tox -e py3.12-common -- project/tests/test_file.py::TestClassName::test_method
```
For testing specific integrations, refer to the test matrix in [sentry_sdk/tox.ini](mdc:sentry_sdk/tox.ini) for finding an entry.
For example, to test django, use:
```bash
tox -e py3.12-django-v5.2.3
```
### Code Quality
Our `linters` tox environment runs `ruff-format` for formatting, `ruff-check` for linting and `mypy` for type checking.
```bash
tox -e linters
```