Metadata-Version: 2.3
Name: example_python_package_with_rust_backend
Version: 1.1.7
Classifier: Programming Language :: Rust
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
License-File: LICENSE.txt
Requires-Python: >=3.7
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM

[![PyPI](https://img.shields.io/pypi/v/example_python_package_with_rust_backend?&label=PyPI)](https://pypi.org/project/example_python_package_with_rust_backend/)
 


A minimal example of a :snake: Python package with a :crab: Rust backend

One of the great aspects of Rust is that calling Rust functions from Python is easy thanks to [maturin](https://github.com/PyO3/maturin)

This repository also includes automated creation and uploading of wheels to PyPI for distribution to Windows :window: , Mac :green_apple: and Linux :penguin: thanks to [maturin-action](https://github.com/PyO3/maturin-action).

The package itself is less import and just prints a few messages to the terminal.

## Install the package with pip

```bash
pip install example_python_package_with_rust_backend
```

## Usage
```
import example_python_package_with_rust_backend

returned_value = example_python_package_with_rust_backend.hello_world(
    int_arg=3,
    float_arg=2.01,
    str_arg='hi'
)
print(returned_value)
```
