Skip to content
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

Update with local installation info #484

Merged
merged 6 commits into from
Jan 25, 2024
Merged
Show file tree
Hide file tree
Changes from 5 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
2 changes: 2 additions & 0 deletions python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,5 @@ In order to obtain relevant modules, you should install them from PyPI directly,
```
pip install geoarrow-rust-core
```

See [DEVELOP.md](docs/DEVELOP.md) in the `docs` folder for more information on developing and building the Python bindings.
36 changes: 35 additions & 1 deletion python/docs/DEVELOP.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,40 @@
# Develop Docs

## Environment installation

## Development

To install versions of the package under active development, you need to have Rust and `maturin` installed, e.g. with:

```
rustup update stable
pip install maturin
```

clone the repo and navigate into it:

```
git clone https://github.com/geoarrow/geoarrow-rs
cd geoarrow-rs
```

From there navigate to the `python/core` (or other package) directory and develop with `maturin` (add the `--release` flag to the final command to build in release mode):
kylebarron marked this conversation as resolved.
Show resolved Hide resolved

```
cd python/core
virtualenv env
source ./env/bin/activate
pip install -U maturin
maturin develop
```

You can also install packages locally with `pip`:

```
pip install .
```


## Environment installation for docs

Install Python dependencies, e.g. mkdocs et al.

Expand Down
Loading