embedded-unit-converter/README.md

# Embedded Unit Converter

Embed a small bit of code that converts between units of measure, e.g.
Fahrenheit to Celsius.

An example of a Rust library that is embeddable in Python.

## Getting setup

Insure the following dependencies are in place:

* Rust v1.34+ (nightly)
  * Install using `rustup toolchain install nightly`
* Python dependencies
  * Python 3 Development headers `apt install python3-dev`
  * pipenv `pip install --user pipenv`

## Running the Python example

1. Build the rust crate first: `cargo build`
1. Install dependencies and run in a virtualenv: `pipenv install && pipenv shell`
1. Create the Python package with: `maturin build`
1. Run the tests: `pytest test.py`

## Documentation

* [PyO3 Python - Rust bindings](https://pyo3.rs/master/get_started.html)
Minor fixes to codebase and docs. 2019-02-06 08:17:16 -05:00			`# Embedded Unit Converter`
Add a basic readme and desire of the project. 2019-02-01 08:41:54 -05:00
Add in benchmarks. 2019-10-30 10:37:01 -04:00			`Embed a small bit of code that converts between units of measure, e.g.`
Update example for PyCon Canada talk. 2019-10-29 10:25:27 -04:00			`Fahrenheit to Celsius.`
Add a basic readme and desire of the project. 2019-02-01 08:41:54 -05:00
Update example for PyCon Canada talk. 2019-10-29 10:25:27 -04:00			`An example of a Rust library that is embeddable in Python.`
Add a basic readme and desire of the project. 2019-02-01 08:41:54 -05:00
Update example for PyCon Canada talk. 2019-10-29 10:25:27 -04:00			`## Getting setup`
Add a basic readme and desire of the project. 2019-02-01 08:41:54 -05:00
			`Insure the following dependencies are in place:`

Update example for PyCon Canada talk. 2019-10-29 10:25:27 -04:00			`* Rust v1.34+ (nightly)`
			* Install using `rustup toolchain install nightly`
Prepare documentation for building a Python and WebAssembly libraries. 2019-02-06 10:39:39 -05:00			`* Python dependencies`
Update example for PyCon Canada talk. 2019-10-29 10:25:27 -04:00			* Python 3 Development headers `apt install python3-dev`
			* pipenv `pip install --user pipenv`
Add a basic readme and desire of the project. 2019-02-01 08:41:54 -05:00
Wire up to run function as Python code. 2019-02-06 08:57:13 -05:00			`## Running the Python example`

			1. Build the rust crate first: `cargo build`
Prepare documentation for building a Python and WebAssembly libraries. 2019-02-06 10:39:39 -05:00			1. Install dependencies and run in a virtualenv: `pipenv install && pipenv shell`
Fix typo in README. 2019-10-29 10:41:01 -04:00			1. Create the Python package with: `maturin build`
Add instructions and test for running against pytest. 2019-02-06 09:04:04 -05:00			1. Run the tests: `pytest test.py`
Wire up to run function as Python code. 2019-02-06 08:57:13 -05:00
Add a basic readme and desire of the project. 2019-02-01 08:41:54 -05:00			`## Documentation`

			`* [PyO3 Python - Rust bindings](https://pyo3.rs/master/get_started.html)`