https://github.com/vishusandy/python_cookiecutter

Basic python cookiecutter template
https://github.com/vishusandy/python_cookiecutter

Last synced: about 1 month ago
JSON representation

Basic python cookiecutter template

• Host: GitHub
• URL: https://github.com/vishusandy/python_cookiecutter
• Owner: vishusandy
• Created: 2023-07-25T03:40:23.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-07-29T16:39:53.000Z (over 1 year ago)
• Last Synced: 2023-07-29T17:33:58.677Z (over 1 year ago)
• Language: Python
• Size: 111 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Python Cookiecutter Template

A [Cookiecutter](https://cookiecutter.readthedocs.io/en/latest/README.html) template for a basic python project with a [src layout](https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/).

Includes:

- pyproject.toml

- test directory

- license (Apache-2.0, MIT, BSD-3-Clause, or none)

- README stub

- git initialization

Prompts:

![Prompts](py_cookie_prompts.png)

Directory layout:

![Project layout](py_cookie_layout.png)

### Prerequisites

[Cookiecutter](https://cookiecutter.readthedocs.io/en/latest/installation.html) must be installed:

```bash

pip install --user cookiecutter

```

## Usage

Use with:

```bash

cookiecutter https://github.com/vishusandy/python_cookiecutter

```

You will be prompted for project information.

### .cookiecutterrc

I recommend the following for your [`~/.cookiecutterrc`](https://cookiecutter.readthedocs.io/en/latest/advanced/user_config.html) file:

```

default_context:

    full_name: ""

    email: ""

    license: "Apache-2.0"

```

### Alias

Personally I find a bash alias in your `~/.bashrc` to be helpful:

```bash

alias pyp="cookiecutter https://github.com/vishusandy/python_cookiecutter"

```

which would be called by running `pyp` in the terminal.