Metadata-Version: 2.1
Name: snickerdoodle_demo
Version: 0.1.0
Summary: Demonstration repository of the snickerdoodle template
Author-Email: Corey Rayburn Yung <coreyrayburnyung@gmail.com>
License: Apache Software License 2.0
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Software Development
Project-URL: Documentation, https://WithPrecedent.github.io/snickerdoodle_demo
Project-URL: Repository, https://github.com/WithPrecedent/snickerdoodle_demo
Project-URL: Issues, https://github.com/WithPrecedent/snickerdoodle_demo/issues
Project-URL: Changelog, https://WithPrecedent.github.io/snickerdoodle_demo/changelog
Requires-Python: >=3.10
Description-Content-Type: text/markdown

# snickerdoodle_demo

| | |
| --- | --- |
| Version | [![PyPI Latest Release](https://img.shields.io/pypi/v/snickerdoodle_demo.svg?style=for-the-badge&label=pypi&logo=PyPI&color=darkorange)](https://pypi.org/project/snickerdoodle_demo/) [![GitHub Latest Release](https://img.shields.io/github/tag/WithPrecedent/snickerdoodle_demo?style=for-the-badge&label=branch&logo=github&color=navy)](https://github.com/WithPrecedent/snickerdoodle_demo/graphs/tags)
| Status | [![Build Status](https://img.shields.io/github/actions/workflow/status/WithPrecedent/snickerdoodle_demo/ci.yml?branch=main&label=tests&style=for-the-badge&logo=pytest&color=cadetblue)](https://github.com/WithPrecedent/snickerdoodle_demo/actions/workflows/ci.yml?query=branch%3Amain) [![Development Status](https://img.shields.io/badge/Development-Active-Green?style=for-the-badge&logo=git)](https://www.repostatus.org/#active) [![Project Stability](https://img.shields.io/badge/stability-beta-firebrick?style=for-the-badge&logo=git)](https://www.repostatus.org/#active) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg?style=for-the-badge&logo=apache&color=goldenrod)](https://opensource.org/licenses/Apache-2.0)
| Docs | [![Hosted By](https://img.shields.io/badge/hosted_by-github_pages-blue?style=for-the-badge&logo=github&color=navy)](https://WithPrecedent.github.io/snickerdoodle_demo)
| Compatibility | [![Compatible Python Versions](https://img.shields.io/pypi/pyversions/snickerdoodle_demo?style=for-the-badge&logo=python&color=darkorange)](https://pypi.python.org/pypi/snickerdoodle_demo/) [![Linux](https://img.shields.io/badge/linux-maroon?style=for-the-badge&logo=linux&labelColor=gray)](https://www.linux.org/) [![MacOS](https://img.shields.io/badge/macos-yellow?style=for-the-badge&logo=apple&labelColor=gray)](https://www.apple.com/macos/) [![Windows](https://img.shields.io/badge/windows-blue?style=for-the-badge&logo=windows&labelColor=gray)](https://www.microsoft.com/en-us/windows?r=1)
| Stats | [![PyPI Download Rate (per month)](https://img.shields.io/pypi/dm/snickerdoodle_demo?style=for-the-badge&logo=pypi&color=darkorange)](https://pypi.org/project/snickerdoodle_demo) [![GitHub Contributors](https://img.shields.io/github/contributors/WithPrecedent/snickerdoodle_demo?style=for-the-badge&label=contributors&logo=github&color=darksalmon)](https://github.com/WithPrecedent/snickerdoodle_demo/graphs/contributors) [![GitHub Contributors](https://img.shields.io/github/issues/WithPrecedent/snickerdoodle_demo?style=for-the-badge&label=issues&logo=github&color=deeppink)](https://github.com/WithPrecedent/snickerdoodle_demo/graphs/contributors) [![GitHub Stars](https://img.shields.io/github/stars/WithPrecedent/snickerdoodle_demo?style=for-the-badge&label=Stars&logo=github&color=firebrick)](https://github.com/WithPrecedent/snickerdoodle_demo/stargazers) [![GitHub Forks](https://img.shields.io/github/forks/WithPrecedent/snickerdoodle_demo?style=for-the-badge&label=forks&logo=github&color=coral)](https://github.com/WithPrecedent/snickerdoodle_demo/forks)
| Tools | [![Documentation](https://img.shields.io/badge/MkDocs-magenta?style=for-the-badge&logo=markdown&labelColor=gray)](https://squidfunk.github.io/mkdocs-material/) [![Linter](https://img.shields.io/endpoint?style=for-the-badge&url=https://raw.githubusercontent.com/charliermarsh/Ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/Ruff) [![Dependency Manager](https://img.shields.io/badge/PDM-blueviolet?style=for-the-badge&logo=affinity&labelColor=gray)](https://PDM.fming.dev) [![Pre-commit](https://img.shields.io/badge/pre--commit-brightgreen?style=for-the-badge&logo=pre-commit&logoColor=white&labelColor=gray)](https://github.com/TezRomacH/python-package-template/blob/master/.pre-commit-config.yaml) [![CI](https://img.shields.io/badge/github_actions-yellow?style=for-the-badge&logo=githubactions&labelColor=gray)](https://github.com/features/actions) [![Editor Settings](https://img.shields.io/badge/editor_config-blue?style=for-the-badge&logo=editorconfig&labelColor=gray)](https://github.com/features/actions) [![Template](https://img.shields.io/badge/snickerdoodle-brown?style=for-the-badge&logo=cookiecutter&labelColor=gray)](https://www.github.com/WithPrecedent/snickerdoodle)
| | |

-----

## What is snickerdoodle_demo?

[TODO: Brief summary of the project]

## Why use snickerdoodle_demo?

[TODO: Features and reasons to use the project (and, possibly, not to use it)]

## Getting started

### Requirements

[TODO: List any OS or other restrictions and pre-installation dependencies]

### Installation

[TODO: Briefly describe, with code blocks, how to install the project]

### Usage

[TODO: Describe common use cases, with possible example(s)]

## Contributing

Contributors are always welcome. Feel free to grab an [issue](https://www.github.com/WithPrecedent/snickerdoodle_demo/issues) to work on or make a suggested improvement. If you wish to contribute, please read the [Contribution Guide](https://www.github.com/WithPrecedent/snickerdoodle_demo/contributing.md) and [Code of Conduct](https://www.github.com/WithPrecedent/snickerdoodle_demo/code_of_conduct.md).

## Similar Projects

[TODO: If they exist, it is always nice to acknowledge other similar efforts]

## Acknowledgments

[TODO: Mention any people or organizations that warrant a special acknowledgment]

## License

Use of this repository is authorized under the [Apache Software License 2.0](https://www.github.com/WithPrecedent/snickerdoodle_demo/blog/main/LICENSE).
