Metadata-Version: 2.1
Name: cookiecutter-python-package-demo
Version: 0.1.0
Summary: Demo of https://github.com/sgraaf/cookiecutter-python-package.
Keywords: 
Author-email: Steven van de Graaf <steven@vandegraaf.xyz>
Requires-Python: ~=3.8
Description-Content-Type: text/markdown
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Typing :: Typed
Requires-Dist: cookiecutter-python-package-demo[tests,docs] ; extra == "dev"
Requires-Dist: furo ; extra == "docs"
Requires-Dist: myst-parser ; extra == "docs"
Requires-Dist: sphinx ; extra == "docs"
Requires-Dist: sphinx-autobuild ; extra == "docs"
Requires-Dist: sphinx-copybutton ; extra == "docs"
Requires-Dist: sphinxext-opengraph ; extra == "docs"
Requires-Dist: pytest ; extra == "tests"
Project-URL: Changelog, https://cookiecutter-python-package-demo.readthedocs.io/en/stable/changelog.html
Project-URL: Documentation, https://cookiecutter-python-package-demo.readthedocs.io/en/stable/
Project-URL: Issue Tracker, https://github.com/sgraaf/cookiecutter-python-package-demo/issues
Project-URL: Source Code, https://github.com/sgraaf/cookiecutter-python-package-demo
Provides-Extra: dev
Provides-Extra: docs
Provides-Extra: tests

<!-- start docs-include-index -->

# Cookiecutter Python Package Demo

[![PyPI](https://img.shields.io/pypi/v/cookiecutter-python-package-demo)](https://img.shields.io/pypi/v/cookiecutter-python-package-demo)
[![Supported Python Versions](https://img.shields.io/pypi/pyversions/cookiecutter-python-package-demo)](https://pypi.org/project/cookiecutter-python-package-demo/)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/sgraaf/cookiecutter-python-package-demo/main.svg)](https://results.pre-commit.ci/latest/github/sgraaf/cookiecutter-python-package-demo/main)
[![Test](https://github.com/sgraaf/cookiecutter-python-package-demo/actions/workflows/test.yml/badge.svg)](https://github.com/sgraaf/cookiecutter-python-package-demo/actions/workflows/test.yml)
[![Documentation Status](https://readthedocs.org/projects/cookiecutter-python-package-demo/badge/?version=latest)](https://cookiecutter-python-package-demo.readthedocs.io/en/latest/?badge=latest)
[![PyPI - License](https://img.shields.io/pypi/l/cookiecutter-python-package-demo)](https://img.shields.io/pypi/l/cookiecutter-python-package-demo)

Demo of https://github.com/sgraaf/cookiecutter-python-package.

<!-- end docs-include-index -->

## Installation

<!-- start docs-include-installation -->

### From PyPI

Cookiecutter Python Package Demo is available on [PyPI](https://pypi.org/project/cookiecutter-python-package-demo/). Install with `pip` or your package manager of choice:

```bash
pip install cookiecutter-python-package-demo
```

### From source

If you'd like, you can also install Cookiecutter Python Package Demo from source (with [`flit`](https://flit.readthedocs.io/en/latest/)):

```bash
git clone https://github.com/sgraaf/cookiecutter-python-package-demo.git
cd cookiecutter-python-package-demo
python3 -m pip install flit
flit install
```

<!-- end docs-include-installation -->

## Documentation

Check out the [Cookiecutter Python Package Demo documentation](https://cookiecutter-python-package-demo.readthedocs.io/en/stable/) for the [User's Guide](https://cookiecutter-python-package-demo.readthedocs.io/en/stable/usage.html) and [API Reference](https://cookiecutter-python-package-demo.readthedocs.io/en/stable/api.html).

## Usage

<!-- start docs-include-usage -->

Usage instructions go here.

<!-- end docs-include-usage -->

