pyo3/examples/word-count/README.md

# word-count

Demonstrates searching for a file in plain python, with rust singlethreaded and with rust multithreaded.

## Build

```shell
python setup.py install
```

## Usage

```python
from word_count import search_py, search, search_sequential

search_py("foo bar", "foo")
search("foo bar", "foo")
search_sequential("foo bar", "foo")
```

## Benchmark

Install the depedencies:

```shell
pip install -r requirements-dev.txt
```


There is a benchmark in `tests/test_word_count.py`:

```shell
pytest -v tests
```

## Testing

To test install tox globally and run

```shell
tox -e py
```

## Copying this example

Use [`cargo-generate`](https://crates.io/crates/cargo-generate):

```bash
$ cargo install cargo-generate
$ cargo generate --git https://github.com/PyO3/pyo3 examples/word-count
```

(`cargo generate` will take a little while to clone the PyO3 repo first; be patient when waiting for the command to run.)