pyo3/README.md

56 lines
1.5 KiB
Markdown
Raw Normal View History

2015-04-19 03:29:19 +00:00
rust-cpython [![Build Status](https://travis-ci.org/dgrunwald/rust-cpython.svg?branch=master)](https://travis-ci.org/dgrunwald/rust-cpython)
====================
[Rust](http://www.rust-lang.org/) bindings for the [python](https://www.python.org/) interpreter.
2015-04-19 05:50:50 +00:00
* [Documentation](http://dgrunwald.github.io/rust-cpython/doc/cpython/)
2015-04-19 03:29:19 +00:00
* Cargo package: [cpython](https://crates.io/crates/cpython)
---
Copyright (c) 2015-2016 Daniel Grunwald.
2015-04-19 03:29:19 +00:00
Rust-cpython is licensed under the [MIT license](http://opensource.org/licenses/MIT).
Python is licensed under the [Python License](https://docs.python.org/2/license.html).
2015-08-02 19:56:03 +00:00
Supported Python versions:
* Python 2.7
* Python 3.3
* Python 3.4
2015-09-13 17:49:09 +00:00
* Python 3.5
2015-04-19 03:29:19 +00:00
2015-09-20 17:43:24 +00:00
Supported Rust version:
* Rust 1.7.0 or later
2015-09-20 17:43:24 +00:00
2015-04-19 03:29:19 +00:00
# Usage
To use `cpython`, add this to your `Cargo.toml`:
2015-04-19 03:29:19 +00:00
```toml
[dependencies]
2015-11-07 16:19:46 +00:00
cpython = { git = "https://github.com/dgrunwald/rust-cpython.git" }
2015-04-19 03:29:19 +00:00
```
Example program displaying the value of `sys.version`:
```rust
extern crate cpython;
2015-12-31 11:43:03 +00:00
use cpython::Python;
use cpython::ObjectProtocol; //for call method
2015-04-19 03:29:19 +00:00
fn main() {
let gil = Python::acquire_gil();
let py = gil.python();
2015-04-19 03:29:19 +00:00
let sys = py.import("sys").unwrap();
2015-12-31 11:43:03 +00:00
let version: String = sys.get(py, "version").unwrap().extract(py).unwrap();
let os = py.import("os").unwrap();
2015-12-31 11:43:03 +00:00
let getenv = os.get(py, "getenv").unwrap();
let user: String = getenv.call(py, ("USER",), None).unwrap().extract(py).unwrap();
println!("Hello {}, I'm Python {}", user, version);
2015-04-19 03:29:19 +00:00
}
```