[](https://pypi.python.org/pypi/{[ cookiecutter.pypi_package_name ]}/)
[](https://github.com/{[ cookiecutter.github_org ]}/{[ cookiecutter.github_repo ]}/actions/workflows/test.yml?query=branch%3Amaster)
{%- if cookiecutter.with_readthedocs == "Yes" %}
{%- endif %}
[](https://coveralls.io/github/{[ cookiecutter.github_org ]}/{[ cookiecutter.github_repo ]}?branch=main)
TODO: Add brief description of the project.
{%- if cookiecutter.package_type == 'Library' %} To install the latest released version of the {[ cookiecutter.project_name ]} project into your active Python environment:
pip install {[ cookiecutter.pypi_package_name ]}
{%- else %}{# CLI #} To install the latest released version of the {[ cookiecutter.project_name ]} project into your system without having any virtual Python environment active:
pipx install {[ cookiecutter.pypi_package_name ]}
{%- endif %}
This will also install any prerequisite Python packages.
{%- if cookiecutter.with_readthedocs == "Yes" %} For more details and alternative ways to install, see Installation.
{%- endif %}
{%- if cookiecutter.with_readthedocs == "Yes" %}
- Change history {%- else %} TODO: Write short documentation here. {%- endif %}
{%- if cookiecutter.with_readthedocs == "Yes" %}
For information on how to contribute to the {[ cookiecutter.project_name ]} project, see Contributing.
{%- endif %}
The {[ cookiecutter.project_name ]} project is provided under the [{[ cookiecutter.license ]}](https://raw.githubusercontent.com/{[ cookiecutter.github_org ]}/{[ cookiecutter.github_repo ]}/main/LICENSE).