Skip to content

Commit bc09ff3

Browse files
adamreeveion-elgreco
authored andcommitted
Update CONTRIBUTING.md and Makefile to account for switch to uv
Signed-off-by: Adam Reeve <[email protected]>
1 parent a82aedd commit bc09ff3

File tree

2 files changed

+6
-11
lines changed

2 files changed

+6
-11
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,26 +15,22 @@ If you want to claim an issue to work on, you can write the word `take` as a com
1515
## Quick start
1616

1717
- Install Rust, e.g. as described [here](https://doc.rust-lang.org/cargo/getting-started/installation.html)
18-
- Have a compatible Python version installed (check `python/pyproject.toml` for current requirement)
19-
- Create a Python virtual environment (required for development builds), e.g. as described [here](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/)
20-
```sh
21-
python -m venv .venv
22-
```
18+
- Install the [uv Python package manager](https://docs.astral.sh/uv/getting-started/installation/).
2319

24-
- Build the project for development (this requires an active virtual environment and will also install `deltalake` in that virtual environment. [Uv](https://github.com/astral-sh/uv) packet manager needs to be installed)
20+
- Build the project for development. This will install `deltalake` into the Python virtual environment managed by uv.
2521
```sh
2622
cd python
2723
make develop
2824
```
2925

3026
- Run some Python code, e.g. to run a specific test
3127
```sh
32-
python -m pytest tests/test_writer.py -s -k "test_with_deltalake_schema"
28+
uv run pytest tests/test_writer.py -s -k "test_with_deltalake_schema"
3329
```
3430

3531
- Run some Rust code, e.g. run an example
3632
```sh
37-
cd crates/deltalake
33+
cd ../crates/deltalake
3834
cargo run --example basic_operations --features="datafusion"
3935
```
4036

python/Makefile

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
.DEFAULT_GOAL := help
22

3-
VENV := venv
4-
MATURIN_VERSION := $(shell grep 'requires =' pyproject.toml | cut -d= -f2- | tr -d '[ "]')
53
PACKAGE_VERSION := $(shell grep version Cargo.toml | head -n 1 | awk '{print $$3}' | tr -d '"' )
64
DAT_VERSION := 0.0.2
75

@@ -96,7 +94,8 @@ build-docs: ## Build documentation with mkdocs
9694
clean: ## Run clean
9795
$(warning --- Clean virtualenv and target directory ---)
9896
cargo clean
99-
rm -rf $(VENV)
97+
# Remove uv's venv
98+
rm -rf .venv
10099
find . -type f -name '*.pyc' -delete
101100

102101
.PHONY: help

0 commit comments

Comments
 (0)