Skip to content

Update how to dev instructions #1179

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,8 @@ You can verify the installation by running:
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
over `pip`.

Currently for protobuf support either [protobuf](https://protobuf.dev/installation/) or cmake must be installed.

Bootstrap (`uv`):

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

The pre-commit hooks can also be run adhoc without installing them by simply running `pre-commit run --all-files`
The pre-commit hooks can also be run adhoc without installing them by simply running `pre-commit run --all-files`.

NOTE: the current `pre-commit` hooks require docker, and cmake. See note on protobuf above.

## Running linters without using pre-commit

Expand Down
4 changes: 2 additions & 2 deletions examples/datafusion-ffi-example/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,16 @@
// specific language governing permissions and limitations
// under the License.

use crate::catalog_provider::MyCatalogProvider;
use crate::aggregate_udf::MySumUDF;
use crate::catalog_provider::MyCatalogProvider;
use crate::scalar_udf::IsNullUDF;
use crate::table_function::MyTableFunction;
use crate::table_provider::MyTableProvider;
use crate::window_udf::MyRankUDF;
use pyo3::prelude::*;

pub(crate) mod catalog_provider;
pub(crate) mod aggregate_udf;
pub(crate) mod catalog_provider;
pub(crate) mod scalar_udf;
pub(crate) mod table_function;
pub(crate) mod table_provider;
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@ max-doc-length = 88
dev = [
"maturin>=1.8.1",
"numpy>1.25.0",
"pre-commit>=4.0.0",
"pytest>=7.4.4",
"pytest-asyncio>=0.23.3",
"ruff>=0.9.1",
Expand Down
Loading