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
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
Built Distribution
File details
Details for the file pytest-spec2md-0.1.2.tar.gz.
File metadata
- Download URL: pytest-spec2md-0.1.2.tar.gz
- Upload date:
- Size: 12.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.13 CPython/3.10.2 Linux/5.13.0-1025-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3a3a2dbf360b5a9b8d7793263dafbebfb70f0f40fb3ab81ae2297a0cbed7d301 |
|
| MD5 | babcc9dd6c6d74be88ef058f049b6e01 |
|
| BLAKE2b-256 | 2127f55a7a928e5c2e1005c047b7bfa6f3719ce2e6feb9d48ecc505ac2cb5f1c |
File details
Details for the file pytest_spec2md-0.1.2-py3-none-any.whl.
File metadata
- Download URL: pytest_spec2md-0.1.2-py3-none-any.whl
- Upload date:
- Size: 18.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.13 CPython/3.10.2 Linux/5.13.0-1025-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a475c91f5282d4f44f1cd98e58006ea9443f8f98eb3611da40cf6a63f17144de |
|
| MD5 | c3412d74e495a734ce0da0f1e6fde3f2 |
|
| BLAKE2b-256 | 8a9842e925b4e52daebd8b9558203dc032fb359c6a99751779e6f371d082ed7a |
