the-hatchlor

Changes from the last version:

• Add: Let git set remote to the project repository during setup
• Fix: Setting pymdownx.magiclink in mkdocs correctly.
• Upd: Updated dependencies of environemnts

Changes from the last version:

• Chg: remove note about adding hatch config set dirs.env.virtual .direnv as hatch is supported by VSC 1.88
• Fix: remove license-files from pyproject.toml as this is not standardized

Changes from the last version:

• Chg: Update .pre-commit-config.yaml

Changes from the last version:

• Chg: update .pre-commit-config.yaml to newest version
• Fix: remove skip-install = true in the lint environment which seems to have suppressed some mypy errors
• Fix: remove superfluous exclude: '^docs/conf.py' from .pre-commit-config.yaml
• Chg: Changed pyproject.toml according the new ruff configuration
• New: Activate social cards in mkdocs by default
• Chg: Updated hatch-pip-compile, ruff & mypy versions in pyproject.toml
• Fix: Some mkdocs deprecations, i.e. materialx.emoji.twemoji

Changes from last version:

• New: use post-install-commands = ["pre-commit install"] in pyproject.toml to make sure the pre-commit hook is installed
• Change: have a clean default environment and test-related tools are now in test environment
• New: add pytest-sugar to test environment
• New: experimental lock-file support using hatch-pip-compile

Changes from last version:

• fix: license propriertary doesn't break hatch as it is no SPX license

Changes since last release:

• Fix: replace periods with underscores when determining pkg_name from project_slug
• Fix: add [tool.hatch.build] -> packages in pyproject.toml to resolve package if project_slug != pkg_name
• Fix: have less dependencies in the pyproject.toml as example to speed up demonstrations

Changes since last release:

• Fix: CHANGELOG.md in template included the changes of Hatchlor itself, now it's a dummmy again

Changes since last release:

• New: Allow the selection of Python 3.12 when setting up the template
• New: Removed black as formatter as this is now done by ruff format
• New: Commands in the lint environment state their version
• New: Use the new Annotated[...] style for typer in skeleton.py
• Fix: Have pytest omit _version.py as this file is generated on the fly by hatch-vcs
• Fix: Let ruff also correct the files in tests, i.e. include configuration fixed
• Fix: Removed unnecessary "fix requirements.txt" in pre-commit configuration
• Docs: More explanation of what hatch does and how to use it in Readme.md of the template
• Docs: More explanation of hatch in general in the-hatchlor's Readme.md
• Test: Also have a Github CI/CD test and a demo repo of the instanciated template

Features:

• Python 3.8 - 3.11 supported
• hatch: Python packaging, environment management and test runner (tox replacement),
• hatch-vcs: determine the package version automatically from git tags, e.g. v0.9,
• pyproject.toml: all package, build and tool configuration in one file,
• pytest: full-featured Python testing tool that helps you write better programs,
• coverage: tool for measuring code coverage of Python programs with pytest integration,
• ruff: extremely fast Python linter, which replaces isort, flake8, etc.,
• mypy: optional static type checker for Python,
• black: the uncompromising Python code formatter everyone loves,
• mkdocs: a fast, simple and downright gorgeous static site generator,
• pre-commit: pre-commit git hooks that make your life easier,
• Markdown: instead of reStructuredText, Markdown is used consistently for all text files,
• EditorConfig: maintain consistent coding styles for multiple developers,
• src-layout: the actual Python package is kept under a src folder avoiding many common errors.