rust2rpm/README.md

# rust2rpm

rust2rpm is a tool for automatically generating RPM spec files for Rust crates.

## Testing

### tox

Invoking `tox` will automatically run the test suite for all supported versions
of Python. `tox -- -vv` can be used to show very verbose output from pytest.

The tox configuration also includes environments for running `mypy` (static
analysis) and `coverage` (running tests and writing a test coverage report
in HTML format).

### pytest

The tests can also be run manually in a virtualenv:

```shell
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt pytest
PYTHONPATH=. python3 -m pytest -vv
deactivate
```

The `UPDATE_FIXTURES=1` environment variable can be set to rewrite the test
fixtures for expected (!) changes in the spec file generator.

## Documentation

Documentation for rust2rpm and its configuration file formats is available in
the `docs/` directory in AsciiDoc format. The included build script can be used
to build man pages from the AsciiDoc sources with asciidoctor.