diff --git a/guide/src/get_started.md b/guide/src/get_started.md index ed5d415c..077dc981 100644 --- a/guide/src/get_started.md +++ b/guide/src/get_started.md @@ -2,15 +2,27 @@ [Rust](http://www.rust-lang.org/) bindings for [Python](https://www.python.org/). This includes running and interacting with python code from a rust binaries as well as writing native python modules. -[API documentation](./doc/index.html) +* User Guide: [stable](https://pyo3.rs) | [master](https://pyo3.rs/master) + +* API Documentation: [master](https://pyo3.rs/master/doc) + +A comparison with rust-cpython can be found [in the guide](https://pyo3.rs/master/rust-cpython.html). ## Usage -Pyo3 supports python 2.7 as well as python 3.5 and up. The minimum required rust version is 1.29.0-nightly 2018-07-16. +Pyo3 supports python 2.7 as well as python 3.5 and up. The minimum required rust version is 1.30.0-nightly 2018-08-18. You can either write a native python module in rust or use python from a rust binary. -### Using rust from python +On some OSs, you need some additional packages. + +E.g. if you are on Ubuntu18.04, please run + +```bash +sudo apt install python3-dev python-dev +``` + +## Using rust from python Pyo3 can be used to generate a native python module. @@ -18,11 +30,11 @@ Pyo3 can be used to generate a native python module. ```toml [package] -name = "rust-py" +name = "string-sum" version = "0.1.0" [lib] -name = "rust_py" +name = "string_sum" crate-type = ["cdylib"] [dependencies.pyo3] @@ -46,16 +58,16 @@ fn sum_as_string(a: usize, b: usize) -> PyResult { Ok((a + b).to_string()) } -/// This module is a python moudle implemented in Rust. +/// This module is a python module implemented in Rust. #[pymodule] -fn rust_py(py: Python, m: &PyModule) -> PyResult<()> { +fn string_sum(py: Python, m: &PyModule) -> PyResult<()> { m.add_wrapped(wrap_function!(sum_as_string))?; Ok(()) } ``` -On windows and linux, you can build normally with `cargo build --release`. On Mac Os, you need to set additional linker arguments. One option is to compile with `cargo rustc --release -- -C link-arg=-undefined -C link-arg=dynamic_lookup`, the other is to create a `.cargo/config` with the following content: +On windows and linux, you can build normally with `cargo build --release`. On macOS, you need to set additional linker arguments. One option is to compile with `cargo rustc --release -- -C link-arg=-undefined -C link-arg=dynamic_lookup`, the other is to create a `.cargo/config` with the following content: ```toml [target.x86_64-apple-darwin] @@ -65,11 +77,11 @@ rustflags = [ ] ``` -Also on macOS, you will need to rename the output from \*.dylib to \*.so. On Windows, you will need to rename the output from \*.dll to \*.pyd. +For developing, you can copy and rename the shared library from the target folder: On macOS, rename `libstring_sum.dylib` to `string_sum.so`, on windows `libstring_sum.dll` to `string_sum.pyd` and on linux `libstring_sum.so` to `string_sum.so`. Then open a python shell in the same folder and you'll be able to `import string_sum`. -[`setuptools-rust`](https://github.com/PyO3/setuptools-rust) can be used to generate a python package and includes the commands above by default. See [examples/word-count](examples/https://github.com/PyO3/pyo3/tree/master/examples/word-count) and the associated setup.py. +To build, test and publish your crate as python module, you can use [pyo3-pack](https://github.com/PyO3/pyo3-pack) or [setuptools-rust](https://github.com/PyO3/setuptools-rust). You can find an example for setuptools-rust in [examples/word-count](examples/word-count), while pyo3-pack should work on your crate without any configuration. -### Using python from rust +## Using python from rust Add `pyo3` this to your `Cargo.toml`: @@ -105,8 +117,11 @@ fn main() -> PyResult<()> { ## Examples and tooling - * [examples/word-count](https://github.com/PyO3/pyo3/tree/master/examples/word-count) _Counting the occurences of a word in a text file_ + * [examples/word-count](examples/word-count) _Counting the occurrences of a word in a text file_ * [hyperjson](https://github.com/mre/hyperjson) _A hyper-fast Python module for reading/writing JSON data using Rust's serde-json_ * [rust-numpy](https://github.com/rust-numpy/rust-numpy) _Rust binding of NumPy C-API_ + * [html-py-ever](https://github.com/PyO3/setuptools-rust/tree/master/html-py-ever) _Using [html5ever](https://github.com/servo/html5ever) through [kuchiki](https://github.com/kuchiki-rs/kuchiki) to speed up html parsing and css-selecting._ * [pyo3-built](https://github.com/PyO3/pyo3-built) _Simple macro to expose metadata obtained with the [`built`](https://crates.io/crates/built) crate as a [`PyDict`](https://pyo3.github.io/pyo3/pyo3/struct.PyDict.html)_ * [point-process](https://github.com/ManifoldFR/point-process-rust/tree/master/pylib) _High level API for pointprocesses as a Python library_ + * [autopy](https://github.com/autopilot-rs/autopy) _A simple, cross-platform GUI automation library for Python and Rust._ + * [orjson](https://github.com/ijl/orjson) _Fast Python JSON library_ \ No newline at end of file