This template requires Cookiecutter 1.4.0 "Shortbread" or higher
Install Cookiecutter and generate a new pytest plugin project:
$ pip install cookiecutter $ cookiecutter https://github.com/pytest-dev/cookiecutter-pytest-plugin
Cookiecutter prompts you for information regarding your plugin:
full_name [Raphael Pierzina]: Andreas Pelme email [[email protected]]: [email protected] github_username [hackebrot]: pelme plugin_name [foobar]: awesome module_name [awesome]: awesome short_description [A simple plugin to use with pytest]: version [0.1.0]: pytest_version [2.9.1]: Select docs_tool: 1 - mkdocs 2 - sphinx 3 - none Choose from 1, 2, 3 : 1 Select license: 1 - MIT 2 - BSD-3 3 - GNU GPL v3.0 Choose from 1, 2, 3 : 2 INFO:post_gen_project:Moving files for mkdocs.
There you go - you just created a minimal pytest plugin:
pytest-awesome/ LICENSE README.rst docs index.md mkdocs.yml pytest_awesome.py setup.py tests conftest.py test_awesome.py tox.ini
README.rstfile that contains useful information about your plugin
If you plan on submitting your plugin to the pytest-dev organization you need to meet the following requirements:
Please see the official guidelines at Submit a Plugin.
We welcome you to contribute to this project. Please visit the documentation to get started!
If you encounter any problems, please file an issue along with a detailed description.
Everyone interacting in the Cookiecutter pytest Plugin project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the PyPA Code of Conduct.
Distributed under the terms of the MIT license, Cookiecutter pytest Plugin is free and open source software.