This project is an example of a full fledged Falcon API service. The intended purpose is to show one of the many ways people can build services with the following features:
- Input Validation
- Simple ORM usage
- Testing
- CLI entrypoint
- Middleware
- Custom Gunicorn Workers
From the cloned source, execute:
pip install -e .
Once installed you can run the service using the falcon-example
command.
Note
The service connects to a MySQL database. You'll need to edit the service
config in etc/example/config.yml
to match your configuration.
Install test requirements
pip install -r dev-requirements.txt
Execute the tests by running the tox
command: