Skip to main content

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


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.3.tar.gz (12.8 kB view hashes)

Uploaded Source

Built Distribution

pytest_spec2md-0.1.3-py3-none-any.whl (19.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page