https://github.com/orangeutan/cookiecutter-beet

https://github.com/orangeutan/cookiecutter-beet

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/orangeutan/cookiecutter-beet
• Owner: OrangeUtan
• Created: 2021-03-18T15:10:03.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-03-18T21:35:10.000Z (almost 4 years ago)
• Last Synced: 2024-08-05T06:01:29.971Z (5 months ago)
• Language: Python
• Size: 43 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# cookiecutter-beet

Minimal [Cookiecutter](https://github.com/cookiecutter/cookiecutter) template for [beet](https://github.com/mcbeet/beet) projects.

## Table of Contents

- [Getting Started](#Getting-Started)

    - [Generate project structure](#Generate-project-structure)

    - [Install build tools](#Install-build-tools)

    - [Install dependencies](#Install-dependencies)

- [Features](#Features)

## Getting Started

### Generate project structure

Install [Cookiecutter](https://github.com/cookiecutter/cookiecutter) and generate new project:

```bash

$ 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](http://www.pyinvoke.org/): `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](https://github.com/mcbeet/beet) project

- Python dependency management with [Poetry](https://python-poetry.org/)

- Version bumping with [tbump](https://github.com/TankerHQ/tbump)

- Build automation using [Invoke](http://www.pyinvoke.org/) or Make

- [pre-commit](https://pre-commit.com/) git hook

- Formatting with [black](https://github.com/psf/black) and [isort](https://github.com/PyCQA/isort)