https://github.com/mrthearman/template

New project template
https://github.com/mrthearman/template

cookiecutter django django-rest-framework python python-poetry templates

Last synced: 3 months ago
JSON representation

New project template

• Host: GitHub
• URL: https://github.com/mrthearman/template
• Owner: MrThearMan
• License: mit
• Created: 2022-06-10T16:53:50.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2025-01-11T07:17:49.000Z (5 months ago)
• Last Synced: 2025-01-21T17:13:43.282Z (5 months ago)
• Topics: cookiecutter, django, django-rest-framework, python, python-poetry, templates
• Language: CSS
• Homepage:
• Size: 96.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Cookiecutter template for writing libraries with poetry

> This template is meant for personal use for my own projects.

## How to use

```shell

pip install cookiecutter

cookiecutter gh:MrThearMan/template

```

## Options

| Setting        | Description                                                                                                |

|----------------|------------------------------------------------------------------------------------------------------------|

| `project_name` | Used for README title, mkdocs site name, and index page title.                                             |

| `project_slug` | Derived from `project_name`, separator is "-". Used in generating `module_slug`, `repo_slug`, `pypi_name`. |

| `module_slug`  | Derived from `project_slug`, separator is "_". Used to generate the project folder and module folder.      |

| `repo_slug`    | Derived from `project_slug`, separator is "-". Used to generate links to the repo.                         |

| `pypi_name`    | Derived from `repo_slug`, separator is "-". Used to for the poetry project name and pip links.             |

| `description`  | Short description for the project. Used for README and mkdocs index page description.                      |