Fubuki is a simple and flexible hybrid web framework. It is lightweight yet powerful, supporting rapid development. Fubuki is influenced by Laravel's features, while providing Flask-like ease of use in areas like routing. It also supports regular expressions in routes, allowing you to store arguments.

Links

Docs

Features

  • Simple and intuitive API
  • Middleware support
  • Serving static files
  • Template engine support
  • Efficient routing
  • Flexible development with hybrid architecture
  • Features influenced by Laravel
  • Flask-like easy routing
  • Supports regular expressions and stores them in route arguments

Installation

To install Fubuki, use the following command:

pip install fubuki

Usage

Creating a Project

To create a new Fubuki project, run the following command:

fubuki create_project <project_name>

Directory Structure

The directory structure of a new project is as follows:

<project_name>/
├── app/
│   ├── __init__.py
│   ├── controllers/
│   │   ├── __init__.py
│   │   └── home_controller.py
│   ├── middlewares/
│   │   ├── __init__.py
│   │   └── logging_middleware.py
│   ├── static/
│   │   └── styles.css
│   ├── templates/
│   │   └── welcome.html
│   ├── routes.py
├── cli.py
├── app.py
└── main.py

Adding a Controller

To add a controller, create a new Python file in the app/controllers directory and define the routes as follows:

from fubuki import Controller, route

class MyController(Controller):
    @classmethod
    @route("/my_path")
    async def my_route(cls, scope, receive, send):
        response = {
            "status": 200,
            "body": "Hello, World!"
        }
        return response

Using Regular Expressions in Routes

Fubuki allows you to use regular expressions in routes, similar to Flask, and store the arguments.

from fubuki import Controller, route

class UserController(Controller):
    @classmethod
    @route("/user/<int:user_id>")
    async def get_user(cls, user_id, scope, receive, send):
        response = {
            "status": 200,
            "body": f"User ID: {user_id}"
        }
        return response
    
    @classmethod
    @route("/post/<regex('^[a-z0-9_-]{3,16}$'):post_slug>")
    async def get_post(cls, post_slug, scope, receive, send):
        response = {
            "status": 200,
            "body": f"Post Slug: {post_slug}"
        }
        return response

Configuring the Application

To add controllers to the application, edit the routes.py file.

from app.controllers.home_controller import UserController

def setup_routes(app):
    for controller_class in [MyController, UserController]:
        app.add_route(controller_class)

Running the Application

To run the application, execute the main.py file.

python main.py

Contributing

Contributions are welcome! You can submit bug reports, feature requests, and pull requests on the GitHub repository.

License

This project is licensed under the MIT License. For more details, see the LICENSE file.

Author