Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/girardinsamuel/cookiecutter-masonite-package
Cookiecutter template to craft quality packages for MasoniteFramework.
https://github.com/girardinsamuel/cookiecutter-masonite-package
cookiecutter-masonite cookiecutter-template masonite
Last synced: about 2 months ago
JSON representation
Cookiecutter template to craft quality packages for MasoniteFramework.
- Host: GitHub
- URL: https://github.com/girardinsamuel/cookiecutter-masonite-package
- Owner: girardinsamuel
- License: mit
- Created: 2020-09-20T23:01:33.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-07T21:01:09.000Z (3 months ago)
- Last Synced: 2024-10-15T15:34:21.317Z (2 months ago)
- Topics: cookiecutter-masonite, cookiecutter-template, masonite
- Language: Python
- Homepage:
- Size: 222 KB
- Stars: 3
- Watchers: 2
- Forks: 2
- Open Issues: 76
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cookiecutter Masonite Package
**Demo**
You can see a demo repository, to have an overview of the scaffolded package result:
[masonite-demo-package](https://github.com/girardinsamuel/masonite-demo-package)
## Masonite Official Documentation
First check the Official Documentation on [creating packages](https://docs.masoniteproject.com/advanced/creating-packages) !
You can also create a package from the official Github template: [starter-package](https://github.com/MasoniteFramework/starter-package).
## Crafting the package
1. Install the latest `cookiecutter` version:
```bash
$ pip install -U cookiecutter
```
2. Generate your Masonite package project following prompt options:
```bash
$ cookiecutter https://github.com/girardinsamuel/cookiecutter-masonite-package.git
```
(_For cookiecutter CLI options, check directly [cookiecutter](https://github.com/cookiecutter/cookiecutter)_).
**Masonite Package Naming Guidelines** ⚠️
To have a consistent Masonite package ecosystem, it is advised to follow Masonite [Naming Guidelines](https://github.com/MasoniteFramework/starter-package).
**TL;DR:**
- The verbose/human name of your package should start with `Masonite` such as `Masonite API`, `Masonite Events`, `Masonite Nice Package`.
- You can slugify this name to get a Python package name (installable with pip). All Masonite packages should have a
Python package name starting with **masonite-** such as `masonite-api`, `masonite-events`, `masonite-nice-package`.
When you are first prompted for the name of your package, enter the readable human name without `Masonite`:
```
project_name [Package Name]: My Package
```
Then the following prompts should not require modifications:
```
project_slug [my-package]:
project_description [Package description in one line displayed e.g. in README]:
pkg_name [my_package]:
[...]
repository [https://github.com/girardinsamuel/masonite-my-package]:
```