Library pytest-spec2md is a pytest plugin to create a markdown specification while running pytest.
Project description
pytest-spec2md
This project is an add-on to pytest. It generates a markdown file as specification, while running the tests.
This project is inspired by pytest-spec.
Getting started
Install the module using pip.
pip install pytest-spec2md
Then you can activate the module using --spec Parameter when calling pytest. You find the generated markdown file under documentation/spec.md.
Configuration
You can change the target directory using the parameter spec_target_file.
[pytest]
spec_target_file = path/to/target/doc/file
Examples
Examples for the usage can be found here: UseCases on GitHub
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pytest-spec2md-0.1.4.tar.gz
(13.2 kB
view hashes)
Built Distribution
Close
Hashes for pytest_spec2md-0.1.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 09ab9d74ce409d17f7a8a1752a6b88fc13e2a9bd54dc3c51923b347e74d4cb30 |
|
MD5 | eeededfa12fe558332dac5a42ae54330 |
|
BLAKE2b-256 | f07cdb5322ee90f6d8f7b3c071c373ed9be951515265cfa5c77257d31f95f93e |