falcon-boilerplate

A boilerplate for the Falcon framework.

Requirements

• Python 3.10+
• gunicorn as the WSGI HTTP server
• gevent as the gunicorn worker
• pydantic for data structures
• vyper for config management
• xid for globally unique identifiers

Using

$ git clone https://github.com/alexferl/falcon-boilerplate.git myapp
$ cd myapp
$ make dev
$ source venv/bin/activate
$ make run
# to see all supported arguments:
$ python run.py --help

To run the tests:

$ make test

Optional Dependencies

• fastjsonschema or jsonschema if you wanna validate the requests/responses with JSON Schema. NOTE: The /users resources will not work if you don't have fastjsonschema or jsonschema installed.
• falcon-crossorigin if you need CORS headers. Must be enabled by passing --cors-enabled to run.py or any of the other ways supported by Vyper.