https://github.com/wwtg99/flask-board
Build base flask app depends on template.
https://github.com/wwtg99/flask-board
command-line flask flask-application python template
Last synced: about 1 month ago
JSON representation
Build base flask app depends on template.
- Host: GitHub
- URL: https://github.com/wwtg99/flask-board
- Owner: wwtg99
- Created: 2020-03-22T05:47:55.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-01-07T10:48:01.000Z (over 5 years ago)
- Last Synced: 2025-07-12T22:26:03.270Z (12 months ago)
- Topics: command-line, flask, flask-application, python, template
- Language: Python
- Size: 25.4 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Flask Board
===========
# Description
[Flask](https://flask.palletsprojects.com/en/1.1.x/) is a powerful and flexible web framework.
Since it is so flexible, we have to "copy" some codes to start a new production project.
Flask Board is aimed to start a flask project depends on some carefully prepared templates.
# Installation
```
pip install flask-board
```
After installation, we can see flask board installed as a flask command plugin.
```
flask board --help
```
# Usage
## Create flask project depends on pre defined templates.
```
flask board your-project
```
Same as using the `default` template.
```
flask board your-project -t default
```
## Available built-in templates
- default: default flask web app
- restful: flask restful API web app
- celery: flask app with celery
## Change the project directory
Change project directory by option `-d`, default use the current directory.
```
flask board your-project -d
```
## Use your own project template
Use `-t` option point to the custom project directory.
```
flask board your-project -t
```
We use jinja2 engine to render all files in the template directory.
We can also exclude files in the template directory (default excludes file patterns *.pyc, *.pyo, *.pyd, *.egg, *.log, *.so, *.zip, *.tar, *.tar.gz).
And exclude directories and all files under it (default excludes directories .git, `__pycache__`, *.egg-info, build, dist, .idea).
```
flask board your-project -t --excludes="*.pyc,*.log" excludes_dir=".git,__pycache__"
```