Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/girardinsamuel/masonite-demo-package

Demo package to show Masonite cookiecutter scaffolding result
https://github.com/girardinsamuel/masonite-demo-package

masonite masonite-package python

Last synced: about 1 month ago
JSON representation

Demo package to show Masonite cookiecutter scaffolding result

Awesome Lists containing this project

README

        

# Demo Package





Masonite Package

GitHub Workflow Status (branch)

PyPI
Python Version
GitHub release (latest by date including pre-releases)
License
Code style: black

## Introduction

Demo package to show Masonite package generator.

## Features

- _Add your package main features here_
- _and here_

## Official Masonite Documentation

New to Masonite ? Please first read the [Official Documentation](https://docs.masoniteproject.com/).
Masonite strives to have extremely comprehensive documentation 😃. It would be wise to go through the tutorials there.
If you find any discrepencies or anything that doesn't make sense, be sure to comment directly on the documentation to start a discussion!

Have questions or want to talk? Be sure to join the [Masonite Discord Community](https://discord.gg/TwKeFahmPZ)!

## Installation

```bash
pip install masonite-demo-package
```

## Configuration

Add DemoPackageProvider to your project in `config/providers.py`:

```python
# config/providers.py
# ...
from demo_package import DemoPackageProvider

# ...
PROVIDERS = [
# ...
# Third Party Providers
DemoPackageProvider,
# ...
]
```

Then you can publish the package resources (if needed) by doing:

```bash
python craft package:publish demo-package
```

## Usage

_Explain how to use your package_

## Contributing

Please read the [Contributing Documentation](CONTRIBUTING.md) here.

## Maintainers

- [Samuel Girardin](https://www.github.com/girardinsamuel)

## License

Demo Package is open-sourced software licensed under the [MIT license](LICENSE).