Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/clarketm/tableexport_flask_app
TableExport + Flask sample app
https://github.com/clarketm/tableexport_flask_app
flask tableexport tableexport-flask
Last synced: 2 months ago
JSON representation
TableExport + Flask sample app
- Host: GitHub
- URL: https://github.com/clarketm/tableexport_flask_app
- Owner: clarketm
- License: bsd-3-clause
- Created: 2016-11-28T05:01:21.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2021-03-19T23:47:01.000Z (almost 4 years ago)
- Last Synced: 2023-02-26T20:18:14.858Z (almost 2 years ago)
- Topics: flask, tableexport, tableexport-flask
- Language: Python
- Homepage: https://tableexport-flask-app.herokuapp.com/
- Size: 5.36 MB
- Stars: 9
- Watchers: 2
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [TableExport](https://github.com/clarketm/TableExport) + [Flask](http://flask.pocoo.org/)
This project is a simple app demonstrating the use of [TableExport](https://github.com/clarketm/TableExport) and [Flask](http://flask.pocoo.org/). It includes a sample project that you can use as a skeleton (or template) to get started.
[](https://heroku.com/deploy?template=https://github.com/clarketm/tableexport_flask_app.git)
### Checkout the [demo](https://tableexport-flask-app.herokuapp.com/)!
## Quickstart
First, set your app's secret key as an environment variable.
> **e.g.** add the following to `.bashrc` or `.bash_profile`.
``` bash
export TABLEEXPORT_FLASK_APP_SECRET='something-really-secret'
```
Before running shell commands, set the `FLASK_APP` and `FLASK_DEBUG` environment variables.
``` bash
export FLASK_APP=/path/to/autoapp.py
export FLASK_DEBUG=1
```
Then run the following commands to bootstrap your environment.
``` bash
git clone https://github.com/clarketm/tableexport_flask_app
cd tableexport_flask_app
pip install -r requirements/dev.txt
bower install
flask run
# open browser to `localhost:5000`
```
You will see a pretty welcome screen.
Once you have installed your DBMS, run the following to create your app's database tables and perform the initial migration.
``` bash
flask db init
flask db migrate
flask db upgrade
flask run
# open browser to `localhost:5000`
```
## Deployment
In your production environment, make sure the `FLASK_DEBUG` environment variable is unset or is set to `0`, so that `ProdConfig` is used.
## Shell
To open the interactive shell, run:
``` bash
flask shell
```
By default, you will have access to the flask `app`.
## Running Tests
To run all tests, run:
``` bash
flask test
```
## Migrations
Whenever a database migration needs to be made. Run the following commands:
``` bash
flask db migrate
```
This will generate a new migration script. Then run:
``` bash
flask db upgrade
```
To apply the migration.
> For a full migration command reference, run `flask db --help`.