cookiecutter-beet

Minimal Cookiecutter template for beet projects.

Table of Contents

• Getting Started
  • Generate project structure
  • Install build tools
  • Install dependencies
• Features

Getting Started

Generate project structure

Install Cookiecutter and generate new project:

$ pip install cookiecutter
$ cookiecutter https://github.com/OrangeUtan/cookiecutter-beet

Cookiecutter prompts you for information about your project:

github_username []: OrangeUtan
minecraft_username [OrangeUtan]: Oran9eUtan
user_namespace [orangeutan]: oran9eutan
project_name []: Hello Beet
project_namespace [hello_beet]:
repo_url: https://github.com/OrangeUtan/hello_beet
description []: My first Beet project
version [0.1.0]:
Select open_source_license:
1 - MIT license
2 - BSD license
3 - ISC license
4 - Apache Software License 2.0
5 - GNU General Public License v3
6 - Not open source
Choose from 1, 2, 3, 4, 5, 6 [1]: 1
minify_release [y]: y
use_poetry [y]: y
Select build_automation:
1 - invoke
2 - make
Choose from 1, 2 [1]: 1
datapack [y]: y
resourcepack [y]: y

Generated project structure

hello_beet
├── datapack
|   └── data
|       ├── global
|       |   └── advancements
|       |       ├── oran9eutan.json
|       |       └── root.json
|       ├── minecraft
|       |   └── tags
|       |       └── functions
|       |           └── load.json
|       └── oran9eutan
|           ├── advancements
|           |   └── hello_beet
|           |       └── root.json
|           └── functions
|               └── hello_beet
|                   ├── load.mcfunction
|                   ├── install.mcfunction
|                   └── uninstall.mcfunction
|
├── resourcepack
|   ├── assets
|   |   └── .mcassetsroot
|   └── pack.png
├── beet-release.json
├── beet.json
├── LINCENSE
├── pyproject.toml
├── README.md
├── tasks.py
└── tbump.toml

Install dependencies

If you want to use Poetry: https://python-poetry.org/docs/#installation

Build automation:

• Either Invoke: pip install invoke
  
• Or you have Make on your system

invoke install or make install

The install task/target will automatically setup Poetry and pre-commit for you

Features

• Preconfigured Beet project
• Python dependency management with Poetry
• Version bumping with tbump
• Build automation using Invoke or Make
• pre-commit git hook
• Formatting with black and isort