Metadata-Version: 2.3
Name: hatch-paulrein-template
Version: 1.0.1
Summary: A hatch plugin to create a better project template.
Project-URL: Documentation, https://github.com/Paul Reinerfelt/hatch-paulrein-template#readme
Project-URL: Issues, https://github.com/Paul Reinerfelt/hatch-paulrein-template/issues
Project-URL: Source, https://github.com/Paul Reinerfelt/hatch-paulrein-template
Author-email: Paul Reinerfelt <Paul.Reinerfelt@gmail.com>
License-Expression: MIT
License-File: LICENSE.txt
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Hatch
Classifier: Programming Language :: Python
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 :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.8
Requires-Dist: hatch
Description-Content-Type: text/markdown

# hatch-paulrein-template

[![PyPI - Version](https://img.shields.io/pypi/v/hatch-paulrein-template.svg)](https://pypi.org/project/hatch-paulrein-template)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/hatch-paulrein-template.svg)](https://pypi.org/project/hatch-paulrein-template)

-----

## Table of Contents

- [Installation](#installation)
- [License](#license)
- [Changes](#changes)

## Installation

```console
pipx inject hatch hatch-paulrein-template
```

## License

`hatch-paulrein-template` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

## Changes

This plug-in is meant to augment the default Hatch template, not replace it.

The following changes to Hatch default template are made:

`pyproject.toml`
:   Add `versioningit` to build dependencies (modify the second line)
:   Change `[tool.hatch.version]` to use `versioningit` (foreach line, find the header and modify the next line)
:   Add `[tool.hatch.env]` and  `[tool.hatch.env.collectors.mkdocs.docs]` tables
:   Add `[tool.hatch.envs.docs]` table with `detached = false` after `[tool.hatch.env.collectors.mkdocs.docs]`
:   Add `[tool.versioningit.next-version]` and `[tool.versioningit.format]` tables
:   Add `[tool.ruff.lint]` and `[tool.ruff.format]` tables

`__about__.py`
:   Modify the `__version__` definition

`cli/__init__.py`
:   make help a normal option and not a group.
:   add click-logging (needs a dependency added as well)

`mkdocs.yml`
:   Write a better configuration

`docs/`
:   Add stub files for a [Diátaxis](https://diataxis.fr/) based documentation.


