seluj78 / flask-utils Goto Github PK

Add nice badges to the README.

For inspiration, see https://github.com/corydolphin/flask-cors and https://github.com/badges/awesome-badges

That way we can have an automatic changelog (#12)

For example https://github.com/conventional-changelog/commitlint but not necessarily, will need to do research

https://github.com/all-contributors/app

Use codecov and pytest-cov

Instead of having

@validate_params(
    {
        "name": str,
        "age": int,
        "is_student": bool,
        "courses": List[str],
        "grades": Dict[str, int],
    }
)
def example():

It would make more sense to have the decorator read the function arguments directly like so :

@validate_params
def example(name: str, age: int, is_student: bool, courses: List[str], grades: Dict[str, int]):

/!\ One attention point is to see how Flask interacts with the function and where it places it's variables when doing a function with some kind of slug (@app.route("/users/<user_id>"))

https://sphinx-notfound-page.readthedocs.io/en/latest/

Refactor documentation to avoid full links in docs (have BadRequestError instead of flask_utils.errors.BadRequestError).

For example https://flask-utils.readthedocs.io/en/latest/api.html#custom-exceptions

Not sure about this one

Add usage examples in the usage section of the documentation

Add https://github.com/PyCQA/flake8-bugbear to the project

Use https://github.com/pypa/cibuildwheel

Waiting to get the namespace https://pypi.org/project/flask-utils/ 🤞

Not sure about this one

Self explanatory. I need a changelog in the repository as well as in the docs. Ideally it would be automatic ?