https://github.com/alexferl/falcon-boilerplate

Boilerplate for the Falcon framework https://github.com/falconry/falcon
https://github.com/alexferl/falcon-boilerplate

12-factor boilerplate config-management falcon falcon-boilerplate falcon-framework gevent gunicorn pydantic python-falcon python3 vyper vyper-config

Last synced: 10 days ago
JSON representation

Boilerplate for the Falcon framework https://github.com/falconry/falcon

• Host: GitHub
• URL: https://github.com/alexferl/falcon-boilerplate
• Owner: alexferl
• License: mit
• Created: 2016-07-12T22:15:19.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-05-07T03:01:31.000Z (6 months ago)
• Last Synced: 2024-10-14T02:27:09.793Z (23 days ago)
• Topics: 12-factor, boilerplate, config-management, falcon, falcon-boilerplate, falcon-framework, gevent, gunicorn, pydantic, python-falcon, python3, vyper, vyper-config
• Language: Python
• Homepage:
• Size: 139 KB
• Stars: 46
• Watchers: 2
• Forks: 8
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# falcon-boilerplate [![Build Status](https://travis-ci.com/alexferl/falcon-boilerplate.svg?branch=master)](https://travis-ci.com/alexferl/falcon-boilerplate) [![codecov](https://codecov.io/gh/alexferl/falcon-boilerplate/branch/master/graph/badge.svg)](https://codecov.io/gh/alexferl/falcon-boilerplate)

A boilerplate for the [Falcon](https://github.com/falconry/falcon) framework.

## Requirements

- Python 3.10+

- [gunicorn](https://github.com/benoitc/gunicorn) as the WSGI HTTP server

- [gevent](https://github.com/gevent/gevent) as the gunicorn worker

- [pydantic](https://github.com/samuelcolvin/pydantic) for data structures

- [vyper](https://github.com/alexferl/vyper) for config management

- [xid](https://github.com/alexferl/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](https://github.com/horejsek/python-fastjsonschema) or

[jsonschema](https://github.com/Julian/jsonschema) if you wanna validate the requests/responses with

[JSON Schema](https://json-schema.org/). **NOTE**: The `/users` resources will not work if you don't have fastjsonschema or jsonschema installed.

- [falcon-crossorigin](https://github.com/admiralobvious/falcon-crossorigin) if you need

[CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) headers.

Must be enabled by passing `--cors-enabled` to `run.py` or any of the other ways supported by Vyper.