Metadata-Version: 2.1
Name: easy-as-pypi
Version: 1.1.17
Summary: Bootstrapping your next Python CLI made easy as PyPI
License: MIT
Keywords: python,boilerplate,pyoilerplate,scaffolding,framework,CLI,TUI,skeleton,cookiecutter
Author: Landon Bouma
Author-email: doblabs@tallybark.com
Maintainer: Tally Bark LLC
Maintainer-email: doblabs@tallybark.com
Requires-Python: >=3.8.1,<4.0.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
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: Topic :: Software Development :: Libraries :: Application Frameworks
Provides-Extra: readthedocs
Requires-Dist: click (>=8.0.0,<9.0.0)
Requires-Dist: sphinx (>=6.2.1,<7.0.0) ; (python_version >= "3.8" and python_version < "3.9") and (extra == "readthedocs")
Requires-Dist: sphinx (>=7.2.6,<8.0.0) ; (python_version >= "3.9" and python_version < "4.0") and (extra == "readthedocs")
Requires-Dist: sphinx-rtd-theme (>=2.0.0rc4,<3.0.0) ; extra == "readthedocs"
Requires-Dist: tomli (>=2.0.1) ; extra == "readthedocs"
Project-URL: documentation, https://easy-as-pypi.readthedocs.io/en/latest
Project-URL: download, https://pypi.org/project/easy-as-pypi/#files
Project-URL: homepage, https://github.com/doblabs/easy-as-pypi#🥧
Project-URL: history, https://github.com/doblabs/easy-as-pypi/blob/release/HISTORY.rst
Project-URL: issues, https://github.com/doblabs/easy-as-pypi/issues
Description-Content-Type: text/x-rst

@@@@@@@@@@@@
easy-as-pypi
@@@@@@@@@@@@

.. CXREF:
   https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge

.. image:: https://github.com/doblabs/easy-as-pypi/actions/workflows/checks-unspecial.yml/badge.svg?branch=release
  :target: https://github.com/doblabs/easy-as-pypi/actions/workflows/checks-unspecial.yml/badge.svg?branch=release
  :alt: Build Status

.. CXREF: https://app.codecov.io/github.com/doblabs/easy-as-pypi/settings/badge

.. image:: https://codecov.io/gh/doblabs/easy-as-pypi/branch/release/graph/badge.svg?token=AlKUyOgTGY
  :target: https://app.codecov.io/gh/doblabs/easy-as-pypi
  :alt: Coverage Status

.. image:: https://readthedocs.org/projects/easy-as-pypi/badge/?version=latest
  :target: https://easy-as-pypi.readthedocs.io/en/latest/
  :alt: Documentation Status

.. image:: https://img.shields.io/github/v/release/doblabs/easy-as-pypi.svg?style=flat
  :target: https://github.com/doblabs/easy-as-pypi/releases
  :alt: GitHub Release Status

.. image:: https://img.shields.io/pypi/v/easy-as-pypi.svg
  :target: https://pypi.org/project/easy-as-pypi/
  :alt: PyPI Release Status

.. image:: https://img.shields.io/pypi/pyversions/easy-as-pypi.svg
  :target: https://pypi.org/project/easy-as-pypi/
  :alt: PyPI Supported Python Versions

.. image:: https://img.shields.io/github/license/doblabs/easy-as-pypi.svg?style=flat
  :target: https://github.com/doblabs/easy-as-pypi/blob/release/LICENSE
  :alt: License Status

|

Boilerplate PyPI project.

.. Install with ``pip``::
..
..     pip3 install easy-as-pypi

########
Overview
########

Boilerplate for modern, bathroom-tub-included Python projects.

The boilerplate itself is installable and includes minimalist Click CLI.

But most of the gold is buried within:

- Modern Poetry and ``pyproject.toml`` setup.

- Supports cascading editable installs (install current project in
  editable mode, as well as any dependencies you might have source
  for locally; boilerplate manages alternative ``pyproject.toml``
  automatically).

- All the lints: ``black``, ``flake8``, ``isort``, ``pydocstyle``,
  ``doc8``, ``linkcheck``, ``poetry check``, and ``twine check``.

- Test against all active Python versions and lint using ``tox``.

- Run tasks, tests, and setup virtualenvs quickly using ``make``
  commands in your active virtualenv.

  - Generate docs for *ReadTheDocs*.

  - Localize user messages using ``Babel``.

  - Easily install to shared or isolated virtualenvs.

- GitHub Actions linting, testing, and coverage upload.

Most of the files are designed to be hard linked from the derived
projects themselves, as they won't need to be customized (such as
``Makefile``).

- Then when the boilerplate changes, you can just commit the
  changes in the derived project, call them "dependency updates"
  or something, and not have to worry about merging changes manually
  (and running ``meld`` or something).


