Skip to content

Commit 3358d23

Browse files
committed
docs: minor corrections to readme
1 parent 8cf59b1 commit 3358d23

File tree

2 files changed

+27
-23
lines changed

2 files changed

+27
-23
lines changed

README.md

Lines changed: 26 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -29,28 +29,6 @@ pip install dataframe-expectations
2929
* pyspark >= 3.3.0
3030
* tabulate >= 0.8.9
3131

32-
### Development setup
33-
34-
To set up the development environment:
35-
36-
```bash
37-
# 1. Clone the repository
38-
git clone https://github.com/getyourguide/dataframe-expectations.git
39-
cd dataframe-expectations
40-
41-
# 2. Install UV package manager
42-
pip install uv
43-
44-
# 3. Install development dependencies (this will automatically create a virtual environment)
45-
uv sync --group dev
46-
47-
# 4. (Optional) To explicitly activate the virtual environment:
48-
source .venv/bin/activate # On Windows: .venv\Scripts\activate
49-
50-
# 5. Run tests (this will run the tests in the virtual environment)
51-
uv run pytest tests/ --cov=dataframe_expectations
52-
```
53-
5432
### Quick Start
5533

5634
#### Pandas Example
@@ -245,6 +223,32 @@ runner = suite.build(tags=["priority:high", "env:prod"], tag_match_mode=TagMatch
245223
runner.run(df)
246224
```
247225

226+
## Development Setup
227+
228+
To set up the development environment:
229+
230+
```bash
231+
# 1. Fork and clone the repository
232+
git clone https://github.com/getyourguide/dataframe-expectations.git
233+
cd dataframe-expectations
234+
235+
# 2. Install UV package manager
236+
pip install uv
237+
238+
# 3. Install development dependencies (this will automatically create a virtual environment)
239+
uv sync --group dev
240+
241+
# 4. Activate the virtual environment
242+
source .venv/bin/activate # On Windows: .venv\Scripts\activate
243+
244+
# 5. Verify your setup
245+
uv run pytest tests/ -n auto --cov=dataframe_expectations
246+
247+
# 6. Install pre-commit hooks
248+
pre-commit install
249+
# This will automatically run checks before each commit
250+
```
251+
248252
## Contributing
249253

250254
We welcome contributions! Whether you're adding new expectations, fixing bugs, or improving documentation, your help is appreciated.

docs/source/getting_started.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ To set up the development environment:
254254
# 5. Verify your setup
255255
uv run pytest tests/ -n auto --cov=dataframe_expectations
256256
257-
# 6. (Optional) Install pre-commit hooks
257+
# 6. Install pre-commit hooks
258258
pre-commit install
259259
# This will automatically run checks before each commit
260260

0 commit comments

Comments
 (0)