Skip to content

Commit ff3fd72

Browse files
authored
Merge pull request #2 from tushushu/wip-publish
How to install, build and publish.
2 parents ef3ed0a + e56a521 commit ff3fd72

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
# ulist
2-
Ultra fast list - Python bindings to Rust Vector.
2+
Ultra fast list - Python bindings to Rust Vector.
33

44

5-
### Maturin
6-
Build and publish crates with pyo3, rust-cpython and cffi bindings as well as rust binaries as python packages.
7-
* `maturin publish` builds the crate into python packages and publishes them to pypi.
5+
### Install
6+
`pip install ulist`
7+
8+
9+
### Build and publish
10+
`ulist` is built and published by `maturin`. The useful commands are listed as below:
11+
* `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.
812
* `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.
9-
* `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.
1013
* `maturin build --release` If we want to benchmark the package.
14+
* `maturin publish` builds the crate into python packages and publishes them to pypi.

0 commit comments

Comments
 (0)