https://github.com/jacebrowning/template-flask

My template for new Flask projects.
https://github.com/jacebrowning/template-flask

Last synced: 29 days ago
JSON representation

My template for new Flask projects.

• Host: GitHub
• URL: https://github.com/jacebrowning/template-flask
• Owner: jacebrowning
• License: unlicense
• Created: 2017-02-15T20:29:39.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2022-12-08T07:44:20.000Z (almost 2 years ago)
• Last Synced: 2024-05-01T21:13:15.423Z (7 months ago)
• Language: Python
• Homepage:
• Size: 506 KB
• Stars: 9
• Watchers: 4
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Jace's Flask Template

This is a [cookiecutter](https://github.com/audreyr/cookiecutter) template for a typical Flask application following modern packaging conventions. It utilizes popular libraries alongside Make and pipenv to fully automate all development and deployment tasks. Check out the live demo: [jacebrowning/template-flask-demo](https://github.com/jacebrowning/template-flask-demo)

[![Build Status](https://img.shields.io/travis/jacebrowning/template-flask/main.svg)](https://travis-ci.org/jacebrowning/template-flask)

## Features

* Settings broken out into local, staging, and production

* API using [Flask API](http://www.flaskapi.org/)

* Unit and integration testing using `pytest`, `pytest-describe`, and `pytest-expecter`

* End-to-end testing using [Splinter](https://splinter.readthedocs.io/)

* `Makefile` for automating common development tasks:

    - Installing dependencies into a virtual environment using `pipenv`

    - Generate superuser and other fixtures to seed the database

    - Running tests against the backend and frontend

    - Running style checkers (`pycodestyle`/`pydocstyle`) and linters (`pylint`)

* Continuous Integration via [CircleCI](https://circleci.com/docs/2.0/)

* Continuous Delivery via [Heroku](https://www.heroku.com/flow)

If you are instead looking for a [Python library](https://caremad.io/posts/2013/07/setup-vs-requirement/) template, check out [jacebrowning/template-python](https://github.com/jacebrowning/template-python).

## Usage

Install `cookiecutter` and generate a project:

```

$ pip install cookiecutter

$ cookiecutter gh:jacebrowning/template-flask -f

```

Cookiecutter will ask you for some basic info (your name, project name, python package name, etc.) and generate a base Python project for you.

## Updates

Checkout the appropriate branch of [template-flask-demo](https://github.com/jacebrowning/template-flask-demo) and manually merge changes into your project.