{"id":13501693,"url":"https://github.com/pytest-dev/cookiecutter-pytest-plugin","last_synced_at":"2025-03-29T09:31:13.656Z","repository":{"id":35414751,"uuid":"39679520","full_name":"pytest-dev/cookiecutter-pytest-plugin","owner":"pytest-dev","description":"A Cookiecutter template for pytest plugins 💻","archived":false,"fork":false,"pushed_at":"2024-09-18T20:33:48.000Z","size":209,"stargazers_count":308,"open_issues_count":7,"forks_count":59,"subscribers_count":15,"default_branch":"main","last_synced_at":"2025-03-17T11:02:53.635Z","etag":null,"topics":["cookiecutter","pytest","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pytest-dev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-07-25T09:33:02.000Z","updated_at":"2025-03-07T14:35:44.000Z","dependencies_parsed_at":"2024-01-18T22:58:18.703Z","dependency_job_id":"af22f74d-0752-4621-9530-7e5c805ec413","html_url":"https://github.com/pytest-dev/cookiecutter-pytest-plugin","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pytest-dev%2Fcookiecutter-pytest-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pytest-dev%2Fcookiecutter-pytest-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pytest-dev%2Fcookiecutter-pytest-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pytest-dev%2Fcookiecutter-pytest-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pytest-dev","download_url":"https://codeload.github.com/pytest-dev/cookiecutter-pytest-plugin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246167179,"owners_count":20734380,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cookiecutter","pytest","python"],"created_at":"2024-07-31T22:01:46.610Z","updated_at":"2025-03-29T09:31:13.366Z","avatar_url":"https://github.com/pytest-dev.png","language":"Python","readme":"# cookiecutter-pytest-plugin\n\n[![Documentation Status][docs_badge]][documentation]\n\nMinimal [Cookiecutter] template for authoring [pytest] plugins that help\nyou write better programs.\n\n## Getting Started\n\nInstall [Cookiecutter] and generate a new pytest plugin project:\n\n```no-highlight\n$ pip install cookiecutter\n$ cookiecutter https://github.com/pytest-dev/cookiecutter-pytest-plugin\n```\n\nCookiecutter prompts you for information regarding your plugin:\n\n```no-highlight\nfull_name [Raphael Pierzina]: Andreas Pelme\nemail [raphael@hackebrot.de]: andreas@pelme.se\ngithub_username [hackebrot]: pelme\nplugin_name [foobar]: awesome\nmodule_name [awesome]: awesome\nshort_description [A simple plugin to use with pytest]:\nversion [0.1.0]:\npytest_version [2.9.1]:\nSelect docs_tool:\n1 - mkdocs\n2 - sphinx\n3 - none\nChoose from 1, 2, 3 [1]: 1\nSelect license:\n1 - MIT\n2 - BSD-3\n3 - GNU GPL v3.0+\nChoose from 1, 2, 3 [1]: 2\nINFO:post_gen_project:Moving files for mkdocs.\n```\n\nThere you go - you just created a minimal pytest plugin:\n\n```no-highlight\npytest-awesome/\n├── LICENSE\n├── README.rst\n├── pyproject.toml\n├── src\n│   └── pytest_awesome\n│       ├── __init__.py\n│       └── plugin.py\n├── tests\n│   ├── conftest.py\n│   └── test_awesome.py\n└── tox.ini\n```\n\n\n## Features\n\n- Installable [PyPI] package featuring a `pyproject.toml`.\n- Test suite running [tox] and [pytest] that makes sure your plugin is working\n  as expected\n- Working example code for a fixture, a cli option, as well as a pytest.ini\n  option\n- Comprehensive `README.rst` file that contains useful information about your\n  plugin\n- Continuous integration configuration for [GitHub Actions]\n- Optional documentation with either [Sphinx] or [MkDocs]\n- Choose from several licenses, such as [MIT], [BSD-3], [Apache v2.0], [GNU GPL\n  v3.0+], or [MPL v2.0]\n\n## Requirements to Submit a Plugin\n\nIf you plan on submitting your plugin to the [pytest-dev organization] you need\nto meet the following requirements:\n\n-   PyPI presence with a pyproject.toml that contains a license, pytest-\n    prefixed, version number, authors, short and long description.\n-   a tox.ini for running tests using tox.\n-   a README describing how to use the plugin and on which platforms\n    it runs.\n-   a LICENSE file or equivalent containing the licensing information.\n-   an issue tracker\n\nPlease see the official guidelines at [Submit a Plugin].\n\n## Resources\n\nPlease consult the [pytest] docs for more information on hooks at\n[pytest hook reference].\n\n## Contribute\n\nWe welcome you to contribute to this project. Please visit the [documentation]\nto get started!\n\n## Issues\n\nIf you encounter any problems, please [file an issue] along with a\ndetailed description.\n\n## Code of Conduct\n\nEveryone interacting in the Cookiecutter pytest Plugin project's codebases,\nissue trackers, chat rooms, and mailing lists is expected to follow the [PyPA\nCode of Conduct].\n\n## License\n\nDistributed under the terms of the [MIT license], Cookiecutter pytest\nPlugin is free and open source software.\n\n[![OSI certified][osi_certified]][OSI]\n\n\n  [pytest-dev organization]: https://github.com/pytest-dev/\n  [docs_badge]: https://readthedocs.org/projects/cookiecutter-pytest-plugin/badge/?version=latest\n  [documentation]: https://cookiecutter-pytest-plugin.readthedocs.io/en/latest/ (Documentation)\n  [Cookiecutter]: https://github.com/audreyr/cookiecutter\n  [pytest]: https://github.com/pytest-dev/pytest\n  [PyPI]: https://pypi.org/project\n  [tox]: https://tox.readthedocs.io/en/latest/\n  [Submit a Plugin]: https://docs.pytest.org/en/latest/contributing.html#submitting-plugins-to-pytest-dev\n  [pytest hook reference]: https://docs.pytest.org/en/latest/writing_plugins.html#pytest-hook-reference\n  [MIT license]: https://opensource.org/licenses/MIT\n  [file an issue]: https://github.com/pytest-dev/cookiecutter-pytest-plugin/issues\n  [Sphinx]: https://sphinx-doc.org/\n  [MkDocs]: https://www.mkdocs.org/\n  [MIT]: https://opensource.org/licenses/MIT\n  [MPL v2.0]: https://www.mozilla.org/media/MPL/2.0/index.txt\n  [BSD-3]: https://opensource.org/licenses/BSD-3-Clause\n  [GNU GPL v3.0+]: https://www.gnu.org/licenses/gpl-3.0.txt\n  [Apache v2.0]: https://www.apache.org/licenses/LICENSE-2.0\n  [GitHub Actions]: https://docs.github.com/en/actions\n  [PyPA Code of Conduct]: https://www.pypa.io/en/latest/code-of-conduct/\n  [Shortbread]: https://github.com/audreyr/cookiecutter/releases/tag/1.4.0\n  [osi_certified]: https://opensource.org/trademarks/osi-certified/web/osi-certified-120x100.png\n  [OSI]: https://opensource.org/\n","funding_links":[],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpytest-dev%2Fcookiecutter-pytest-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpytest-dev%2Fcookiecutter-pytest-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpytest-dev%2Fcookiecutter-pytest-plugin/lists"}