https://github.com/mamerisawesome/froi

Flask routing interface
https://github.com/mamerisawesome/froi

List: froi

flask flask-routing flask-swagger flask-wrapper

Last synced: 2 months ago
JSON representation

Flask routing interface

• Host: GitHub
• URL: https://github.com/mamerisawesome/froi
• Owner: mamerisawesome
• License: mit
• Created: 2019-05-06T14:37:46.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2020-01-16T08:32:11.000Z (over 6 years ago)
• Last Synced: 2025-11-08T20:03:29.386Z (8 months ago)
• Topics: flask, flask-routing, flask-swagger, flask-wrapper
• Language: Python
• Size: 7.81 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
Froi (Flask Router Object Interface)

====================================

A wrapper for Flask's native routing as a form of template.

Routes will be defined as objects to easily define domains.

.. code-block:: python

    # Inside some route object

    from froi import Froi

    class SomeRoute(Froi):

        def __init__(self, app):

            super().__init__(app, 'SomeRoute', '/some_route')

        def install(self):

            # define a get route on base

            self.setget().route(func=sample_fxn_1)

            # define a post

            self.setpost().route('/do_something', func=sample_fxn_2)

            # define a put

            self.setput().route('/edit_something', func=sample_fxn_3)

            # define a delete

            self.setdelete().route('/delete_something', func=sample_fxn_4)

    # Inside your server handler

    from flask import Flask

    from some_route import SomeRoute

    app = Flask(config.APP_NAME)

    SomeRoute(app).install()

    app.run()

If you want a RESTful pattern to handle the routes, you can omit defining the `install` function.

.. code-block:: python

    from froi import Froi

    class SomeRoute(Froi):

        def __init__(self, app):

            super().__init__(app, 'SomeRoute', '/some_route')

        def get(self):

            ... do something

        def post(self):

            ... do something

This will automatically create the defined `GET`, `POST`, `PUT`, and `DELETE` endpoints.