Skip to content

Commit 28dad85

Browse files
committed
Add note for dev setup
1 parent 2e1b713 commit 28dad85

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,6 +216,8 @@ You can verify the installation by running:
216216
This assumes that you have rust and cargo installed. We use the workflow recommended by [pyo3](https://github.com/PyO3/pyo3) and [maturin](https://github.com/PyO3/maturin). The Maturin tools used in this workflow can be installed either via `uv` or `pip`. Both approaches should offer the same experience. It is recommended to use `uv` since it has significant performance improvements
217217
over `pip`.
218218

219+
Currently for protobuf support either [protobuf](https://protobuf.dev/installation/) or cmake must be installed.
220+
219221
Bootstrap (`uv`):
220222

221223
By default `uv` will attempt to build the datafusion python package. For our development we prefer to build manually. This means
@@ -278,7 +280,9 @@ Our pre-commit hooks can be installed by running `pre-commit install`, which wil
278280
your DATAFUSION_PYTHON_ROOT/.github directory and run each time you perform a commit, failing to complete
279281
the commit if an offending lint is found allowing you to make changes locally before pushing.
280282

281-
The pre-commit hooks can also be run adhoc without installing them by simply running `pre-commit run --all-files`
283+
The pre-commit hooks can also be run adhoc without installing them by simply running `pre-commit run --all-files`.
284+
285+
NOTE: the current `pre-commit` hooks require docker, and cmake. See note on protobuf above.
282286

283287
## Running linters without using pre-commit
284288

0 commit comments

Comments
 (0)