Falcon commandline tool
Project description
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
tests
subdirectory - Creates a
src
subdirectory - Creates an empty
src/api.py
- Creates an empty
requirements.txt
file in the root directory - Creates an empty
README.md
file in the root directory - Creates an empty
CODEOWNERS
file in the root directory
- Creates a
- Allow for the creation of additional resources if specified by flags:
--dockerfile
creates an emptyDockerfile
in the root directory--modelsfile
creates an emptymodels.py
insrc/api
directory--dbfile
creates an emptydb.py
insrc/api
directory--resourcesfile
creates an emptyresources.py
insrc/api
directory- '--tox' creates an empty
tox.ini
in the root directory
Installation
$> pip install falcontool
Usage
$> 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 ../
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
falcontool-0.2.0.tar.gz
(3.0 kB
view hashes)
Built Distribution
Close
Hashes for falcontool-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eb1394ba8771355d7df74efe5308d2e53b88807052d60abe4e22293f9eff8623 |
|
MD5 | 8003c3e49c0c64680e34262683c0e442 |
|
BLAKE2b-256 | 4db9482f762b665a45cf9ed41e97b4b1d560648680d53852e84956066d527694 |