Git Product home page Git Product logo

flask-utils's Introduction

Documentation Status GitHub commit activity GitHub commits since latest release GitHub Actions Workflow Status GitHub Actions Workflow Status GitHub License All Contributors codecov

Flask-Utils

A collection of useful Flask utilities I use every day in my Flask projects.

Installation

pip install flask-utils

Usage

from flask import Flask
from flask_utils import FlaskUtils
from flask_utils import BadRequestError

app = Flask(__name__)
utils = FlaskUtils(app, register_error_handlers=True)

@app.route('/')
def index():
    raise BadRequestError
from typing import List, Optional
from flask import Flask
from flask_utils import validate_params

app = Flask(__name__)

@app.post('/create-user')
@validate_params({"first_name": str, "last_name": str, "age": Optional[int], "hobbies": List[str]})
def create_user():
    # ...
    # This will enforce the following rules:
    # - first_name and last_name must be strings and are required
    # - age is optional and must be an integer
    # - hobbies is a list of strings
    # This is just an example, you can use any type of validation you want
    return "User created"

Documentation

You can find the full documentation at Read the Docs

Testing

Install the requirements

pip install -r requirements-dev.txt

Make sure tox is at the latest version

pip install --upgrade tox

Run the tests

tox

OR

Run the tests multi-threaded

tox -p

Contributors

Jules Lasne
Jules Lasne

๐Ÿ’ป ๐Ÿ“– ๐Ÿš‡ ๐Ÿ’ก ๐Ÿง‘โ€๐Ÿซ ๐Ÿ“ฆ ๐Ÿ“† ๐Ÿ‘€ โœ…
Mews
Mews

๐Ÿ“– โœ…
Julien Palard
Julien Palard

๐Ÿค”
Add your contributions

flask-utils's People

Contributors

seluj78 avatar mews avatar allcontributors[bot] 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.