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.2.tar.gz
(12.0 kB
view hashes)
Built Distribution
Close
Hashes for pytest_spec2md-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a475c91f5282d4f44f1cd98e58006ea9443f8f98eb3611da40cf6a63f17144de |
|
MD5 | c3412d74e495a734ce0da0f1e6fde3f2 |
|
BLAKE2b-256 | 8a9842e925b4e52daebd8b9558203dc032fb359c6a99751779e6f371d082ed7a |