add example

Author: fafhrd91

.gitignore

@@ -1,5 +1,6 @@
 *.pyc
 *.pyo
+*.so
 /dist
 /build
 /*.egg-info

README.rst

@@ -15,7 +15,7 @@ setup.py
 
    setup(name='hello-rust',
          version='1.0',
-         rust_extensions=[RustExtension('hello_rust._hello_rust', 'extensions/Cargo.toml')],
+         rust_extensions=[RustExtension('hello_rust._helloworld', 'extensions/Cargo.toml')],
          packages=['hello_rust'],
          # rust extensions are not zip safe, just like C-extensions.
          zip_safe=False
@@ -28,20 +28,20 @@ You can use same commands as for c-extensions. For example::
    running develop
    running egg_info
    writing hello-rust.egg-info/PKG-INFO
-   writing top-level names to hello-rust.egg-info/top_level.txt
-   writing dependency_links to hello-rust.egg-info/dependency_links.txt
-   reading manifest file 'hello-rust.egg-info/SOURCES.txt'
-   writing manifest file 'hello-rust.egg-info/SOURCES.txt'
+   writing top-level names to hello_rust.egg-info/top_level.txt
+   writing dependency_links to hello_rust.egg-info/dependency_links.txt
+   reading manifest file 'hello_rust.egg-info/SOURCES.txt'
+   writing manifest file 'hello_rust.egg-info/SOURCES.txt'
    running build_ext
    running build_rust
    cargo build --manifest-path extensions/Cargo.toml --features python27-sys
        Finished debug [unoptimized + debuginfo] target(s) in 0.0 secs
 
-   Creating /.../lib/python2.7/site-packages/hello-rust.egg-link (link to .)
+   Creating /.../lib/python2.7/site-packages/hello_rust.egg-link (link to .)
 
-   Installed hello-rust
-   Processing dependencies for hello-rust==1.0
-   Finished processing dependencies for hello-rust==1.0
+   Installed hello_rust
+   Processing dependencies for hello_rust==1.0
+   Finished processing dependencies for hello_rust==1.0
 
 
 Or you can use commands like `bdist_wheel` or `bdist_egg`

example/extensions/Cargo.toml

@@ -0,0 +1,18 @@
+[package]
+
+name = "hello-world"
+version = "0.0.1"
+authors = ["James Salter <[email protected]>"]
+
+[features]
+python27-sys = ["cpython/python27-sys"]
+python3-sys = ["cpython/python3-sys"]
+
+[dependencies.cpython]
+git = "https://github.com/dgrunwald/rust-cpython.git"
+rev = "e644f24"
+default-features = false
+
+[lib]
+name = "helloworld"
+crate-type = ["cdylib"]

example/extensions/src/lib.rs

@@ -0,0 +1,30 @@
+#![crate_type = "dylib"]
+
+#[macro_use] extern crate cpython;
+
+use cpython::{PyObject, PyResult, Python, PyTuple, PyDict};
+
+py_module_initializer!(_helloworld, init_helloworld, PyInit_helloworld, |py, m| {
+    try!(m.add(py, "__doc__", "Module documentation string"));
+    try!(m.add(py, "run", py_fn!(py, run(*args, **kwargs))));
+    try!(m.add(py, "val", py_fn!(py, val())));
+    Ok(())
+});
+
+fn run(py: Python, args: &PyTuple, kwargs: Option<&PyDict>) -> PyResult<PyObject> {
+    println!("Rust says: Hello Python!");
+    for arg in args.iter(py) {
+        println!("Rust got {}", arg);
+    }
+    if let Some(kwargs) = kwargs {
+        for (key, val) in kwargs.items(py) {
+            println!("{} = {}", key, val);
+        }
+    }
+    Ok(py.None())
+}
+
+fn val(_: Python) -> PyResult<i32> {
+    Ok(42)
+}
+

example/hello_rust/__init__.py

@@ -0,0 +1,5 @@
+from . import _helloworld
+
+
+def hello():
+    _helloworld.run(_helloworld.val())

example/setup.py

@@ -0,0 +1,11 @@
+from setuptools import setup
+from setuptools_rust import RustExtension
+
+
+setup(name='hello-rust',
+      version='1.0',
+      rust_extensions=[RustExtension('hello_rust._helloworld', 'extensions/Cargo.toml')],
+      packages=['hello_rust'],
+      # rust extensions are not zip safe, just like C-extensions.
+      zip_safe=False
+)