Giter Club home page Giter Club logo

flask-blueprints-loader's Introduction

Flask-Blueprints-Loader

GitHub Workflow Status (with event) Codecov

Flask-Blueprints-Loader is an extension for Flask that automatically discovers and registers Blueprint for your application.

Features

  • Automatic loading and registration of Flask blueprints.
  • Easy configuration via Flask app configuration variables.

Why Use Flask-Blueprints-Loader?

Flask-Blueprints-Loader is particularly useful for Large Applications as Packages that heavily rely on blueprints. Instead of manually registering each blueprint, this extension allows you to automate the process by automatically discovering and registering all blueprints for your application.

Installation

Flask-Blueprints-Loader is available on PyPI and can be installed with various Python Application dependency management tools.

Install using pip:

pip install flask-blueprints-loader

Initialize the Extension

  • Application Instance Pattern
from flask import Flask
from flask_blueprints_loader import BlueprintsLoader

app = Flask(__name__)
loader = BlueprintsLoader(app)

with app.app_context():
    loader.load_blueprints()
  • Application Factories Pattern
from flask import Flask
from flask_blueprints_loader import BlueprintsLoader

loader = BlueprintsLoader()

def create_app():
    app = Flask(__name__)
    loader.init_app(app)

    with app.app_context():
        loader.load_blueprints()

    return app

Directory Structure

Flask-Blueprints-Loader expects your blueprints to be organized in a specific directory structure. By default, it looks for blueprints under the current_app.root_path directory or in the subdirectory specified by the BLUEPRINTS_LOADER_PATH_NAME configuration parameter. Each blueprint should be in its own package and contain a module named "views" (or as specified by the BLUEPRINTS_LOADER_MODULE_NAME configuration parameter) that defines the Blueprint instance and route definitions. If your blueprints are not organized in this way, you may need to make changes to your code to use Flask-Blueprints-Loader.

Configuration

BLUEPRINTS_LOADER_PATH_NAME (str) : The name of the subdirectory containing the blueprints. By default, blueprints are under the current_app.root_path.

BLUEPRINTS_LOADER_MODULE_NAME (str) : The name of the module containing the blueprints. By default, it is set to "views".

BLUEPRINTS_LOADER_UNLOADS (list) : A list of blueprint names to exclude from loading. By default, it is an empty list.

Links

License

This project is under the MIT license.

flask-blueprints-loader's People

Contributors

curskey avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.