pypa-hatch/docs/config/project-templates.md

1.3 KiB

Project templates


You can control how new projects are created by the new command using Hatch's config file.

Author

[template]
name = "..."
email = "..."

Licenses

[template.licenses]
headers = true
default = [
  "MIT",
]

The list of licenses should be composed of SPDX identifiers. If multiple licenses are specified, then they will be placed in a LICENSES directory.

Options

Tests

This adds a tests directory with environments for testing and linting.

[template.plugins.default]
tests = true

CI

This adds a GitHub Actions workflow that runs tests on all platforms using modern versions of Python.

[template.plugins.default]
ci = false

src layout

See this blog post.

[template.plugins.default]
src-layout = true

Feature flags

Command line interface

The --cli flag adds a CLI backed by Click that can also be invoked with python -m <PKG_NAME>.