========
Tutorial
========

To start with, you will need a `GitHub account`_ and an account on `PyPI`_ (optional).
Create these before you get started on this tutorial. If you are new to Git and
GitHub, you should probably spend a few minutes on some of the tutorials at the
top of the page at `GitHub Help`_.

.. toctree::
   :maxdepth: 2
   :caption: Project Initialization

   initialization/editorconfig
   initialization/flake8
   initialization/black
   initialization/isort
   initialization/mypy
   initialization/pre-commit

.. toctree::
   :maxdepth: 2
   :caption: Project Setup

   setup/fire
   setup/loguru
   setup/dynaconf
   setup/pytest
   setup/coverage
   setup/pytest-cov
   setup/tox

.. toctree::
   :maxdepth: 2
   :caption: Project Deployment

   deployment/sphinx
   deployment/gh-actions
   deployment/gh-pages
   deployment/pypi

.. toctree::
   :maxdepth: 2
   :caption: Miscellaneous

   miscellaneous/gh-issue-templates
   miscellaneous/cookiecutter

.. _GitHub account: https://github.com/
.. _PyPI: https://pypi.python.org/pypi
.. _GitHub Help: https://help.github.com/