Falcontool: a simple utility to create and work with Falcon-based projects
Falcontool is an attempt to provide tooling for quickly and easily starting a Falcon-based project.
It is inspired by Django's django-admin and Flask's flask.
Falcontool does the following:
- Creates a project repository given a
project_name - Sets up the basic project scaffolding, including:
- Creates a
testssubdirectory - Creates a
srcsubdirectory - Creates an empty
src/api.py - Creates an empty
requirements.txtfile in the root directory - Creates an empty
README.mdfile in the root directory - Creates an empty
CODEOWNERSfile in the root directory
- Creates a
- Creates additional resources if specified by flags:
-
--dockerfilecreates an emptyDockerfilein the root directory -
--modelsfilecreates an emptymodels.pyinsrc/apidirectory -
--dbfilecreates an emptydb.pyinsrc/apidirectory -
--resourcesfilecreates an emptyresources.pyinsrc/apidirectory -
--toxcreates an emptytox.iniin the root directory
-
- Provides the
shellcommand to get a Python console (support IPython if installed) - Provides the
runcommand to start the API server
Installation
$> pip install falcontoolUsage
$> falcon create foo
created directory foo
created directory tests
created directory src
created file requirements.txt
created file README.md
created file src/api.py
created file CODEOWNERS
$> cd foo
$> ll -a ./*
-rw-r--r-- 1 tjb tjb 40 Sep 29 20:23 ./CODEOWNERS
-rw-r--r-- 1 tjb tjb 40 Sep 29 20:23 ./README.md
-rw-r--r-- 1 tjb tjb 40 Sep 29 20:23 ./requirements.txt
./src:
total 12
drwxr-xr-x 2 tjb tjb 4096 Sep 29 20:23 ./
drwxr-xr-x 4 tjb tjb 4096 Sep 29 20:23 ../
-rw-r--r-- 1 tjb tjb 40 Sep 29 20:23 api.py
./tests:
total 8
drwxr-xr-x 2 tjb tjb 4096 Sep 29 20:23 ./
drwxr-xr-x 4 tjb tjb 4096 Sep 29 20:23 ../
$> falcon shell
Cannot find IPython. Falling back to Python console.
Python 3.7.4 (default, Aug 19 2019, 22:20:25)
[GCC 8.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
(InteractiveConsole)
>>>
$> falcon run
[2019-09-30 18:15:25 -0400] [17047] [INFO] Starting gunicorn 19.9.0
[2019-09-30 18:15:25 -0400] [17047] [INFO] Listening at: http://127.0.0.1:8000 (17047)
[2019-09-30 18:15:25 -0400] [17047] [INFO] Using worker: sync
[2019-09-30 18:15:25 -0400] [17050] [INFO] Booting worker with pid: 17050
