https://github.com/tarsil/cookiecutter-pypackages

A cookiecutter that helps the generation of python projects (packages)
https://github.com/tarsil/cookiecutter-pypackages

Last synced: 10 days ago
JSON representation

A cookiecutter that helps the generation of python projects (packages)

• Host: GitHub
• URL: https://github.com/tarsil/cookiecutter-pypackages
• Owner: tarsil
• License: mit
• Created: 2023-05-02T15:09:55.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-09T10:38:08.000Z (6 months ago)
• Last Synced: 2024-10-30T03:49:30.388Z (about 2 months ago)
• Language: Shell
• Size: 109 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Cookiecutter for python projects

Generate initial python project scaffolds with ease using cookiecutter.

Starting a python project, usually the naming and folder structure takes some time.

This cookiecutter simply makes that process less painful.

## Requirements

* Python 3.8+

* [Cookiecutter](https://cookiecutter.readthedocs.io/en/stable/)

* [Hatch](https://hatch.pypa.io/latest/)

### How to install

In your command line (terminal), run:

```shell

$ cookiecutter https://github.com/tarsil/cookiecutter-pypackages

```

The package comes with a common base using `pyproject.toml` as base and it should be enough for

you to start any python project package.

This comes also with the `pre-commit` configurations that can help you out tremendously.

Follow the instructions.