Skip to content
Merged
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
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
# ulist
Ultra fast list - Python bindings to Rust Vector.
Ultra fast list - Python bindings to Rust Vector.


### Maturin
Build and publish crates with pyo3, rust-cpython and cffi bindings as well as rust binaries as python packages.
* `maturin publish` builds the crate into python packages and publishes them to pypi.
### Install
`pip install ulist`


### Build and publish
`ulist` is built and published by `maturin`. The useful commands are listed as below:
* `maturin develop` builds the crate and installs it as a python module directly in the current virtualenv. Note that while maturin develop is faster, it doesn't support all the features that running pip install after `maturin build` supports.
* `maturin build` builds the wheels and stores them in a folder (target/wheels by default), but doesn't upload them. It's possible to upload those with twine.
* `maturin develop` builds the crate and installs it as a python module directly in the current virtualenv. Note that while maturin develop is faster, it doesn't support all the feature that running pip install after `maturin build` supports.
* `maturin build --release` If we want to benchmark the package.
* `maturin publish` builds the crate into python packages and publishes them to pypi.