Hypermodern Python Cookiecutter
===============================

.. toctree::
   :hidden:
   :maxdepth: 1

   Quickstart <quickstart>
   guide
   contributing
   contributors
   Code of Conduct <codeofconduct>
   License <license>
   Changelog <https://github.com/cjolowicz/cookiecutter-hypermodern-python/releases>

.. rst-class:: badges

.. include:: ../README.rst
   :start-after: badges-begin
   :end-before: badges-end

Cookiecutter_ template for a Python package
based on the `Hypermodern Python`_ article series.


Usage
-----

.. code:: console

   $ cookiecutter gh:cjolowicz/cookiecutter-hypermodern-python \
     --checkout="2020.9.15"


Features
--------

.. include:: ../README.rst
   :start-after: features-begin
   :end-before: features-end


FAQ
---

  *What is this project about?*

The mission of this project is to
enable current best practices
through modern Python tooling.

  *What makes this project different from other Python templates?*

This is a general-purpose template for Python libraries and applications.

Our goals are:

- Focus on simplicity and minimalism
- Promote code quality through automation
- Provide reliable and repeatable processes

The project template is centered around the following tools:

- Poetry_ for packaging and dependency management
- Nox_ for automation of checks and other development tasks
- `GitHub Actions`_ for continuous integration and delivery

  *Why is this Python template called "hypermodern"?*

Hypermodernism_ is a school of chess that dates back to more than a century ago.
If this setup ever goes out of fashion,
I can pretend it was my secret plan from the start.
All images on the
`associated blog <Hypermodern Python_>`__ show
`past visions <Retrofuturism_>`__ of the future.

.. _Hypermodernism: https://en.wikipedia.org/wiki/Hypermodernism_(chess)
.. _Retrofuturism: https://en.wikipedia.org/wiki/Retrofuturism

.. include:: ../README.rst
   :start-after: references-begin
   :end-before: references-end