masonite-modules 0.0.5

Modularize your masonite project

Masonite Modules

Introduction

Modularize your masonite project.

Installation

pip install masonite-modules

Configuration

Add ModuleProvider to your project in config/providers.py:

# config/providers.py
# ...
from masonite_modules import ModuleProvider

# ...
PROVIDERS = [
    # ...
    # Third Party Providers
    ModuleProvider,
    # ...
]

Publish the package resources by doing:

python craft package:publish modules

The default modules location will be modules in the root directory of your project. But if you want your own custom name then, update the module name in config/modules.py to your desired module path name.

NAME=modules

Installation

Once you finish publishing package, you need to install the modules by doing:

$ python craft module:install

Finally, you will see the modules directory created in your project root.

Usage

To create the module, simply run:

$ python craft module:create <module_name>

# Example
$ python craft module:create blog

The above command will create a new module called blogs in the modules directory. It will also create all the necessary files and directories inside blogs so you can start working on your module.

Finally, visit /<module_name> i.e. /blogs then you will see a welcome message.

Enjoy!

License

masonite_modules is open-sourced software licensed under the MIT license.