hatchit package¶

Submodules¶

hatchit.cli module¶

hatchit.cli.main()[source]¶

hatchit.scaffold module¶

hatchit.scaffold.create_hatchit_repository(project_path, description, license)[source]¶

Create a new Python project using uv and hatch.

This function initializes a new Python project at the specified project_path using the uv tool and hatch for version management and project scaffolding. It sets up a basic project structure, including source code, tests, documentation, and configuration files. The function also customizes certain files based on the provided description and license.

Parameters:

  • project_path (str) – The path where the new project should be created.

  • description (str) – A short description of the project.

  • license (str) – The license to use for the project.

Return type:

None

Example

>>> create_hatchit_repository(
...     "my_project",
...     description="My new project",
...     license="MIT",
... )
CLI usage:

$ hatchit my_project –description “My new project” –license MIT

Module contents¶