realpython / cookiecutter-flask-skeleton

Real Python Flask Starter Project

This project is no longer maintained. You can find the maintained version at https://github.com/testdrivenio/cookiecutter-flask-skeleton

Flask Skeleton

Flask starter project for Cookiecutter.

Quick Start

Install Cookiecutter globally:

$ pip install cookiecutter

Generate the boilerplate:

$ cookiecutter https://github.com/realpython/cookiecutter-flask-skeleton.git

Once generated, review the setup guides, within the newly created project directory, to configure the app:

1. setup-with-docker.md
2. setup-without-docker.md

cookiecutter-flask-skeleton's Issues

bump flask version

use app factory

https://stackoverflow.com/questions/42754341/use-flasks-click-cli-with-the-app-factory-pattern

upgrade to bootstrap 4

Create cookiecutter template

https://github.com/audreyr/cookiecutter

Examples:

1. https://github.com/sloria/cookiecutter-flask
2. https://github.com/candidtim/cookiecutter-flask-minimal

How to solve this problem?

Profiler not active
The profiler is not activated, activate it to use it

added Flask CLI

remove flask_script and add Flask CLI

default startup is development mode

in server/__init__py:35
If a server admin forgets to set the APP_SETTINGS env or has a typo there the projects starts in development mode.
For security reasons the default mode should be production - still better to start in broken production environment than starting in develop mode where e.g. authentication might be disabled

How to edit an already existing user?

Hi,

I'm using this skeleton for a project of mine and wanted to display a form so the user can edit its attributes (email address, display name, etc.). How can one achieve this using this template? I can display all of a user's attributes in the form and re-submit them, but how to make the actual update of the user?

Replace unittest with pytest

I really like this template, as it provides a nice balance between a good foundation and not too many features/ opinions. Thus I use it quite often.

Personally I always replace the test section and write all tests with pytest and WebTest. I think that a mixture of both makes it easier to write tests. It's also possible to write not just unittest but also integration and system tests without too much effort.

I thought of forking this repo and adding my changes for personal use. But because I think that other users would benefit from such a change, I thought of asking here first.

Greetings

update requirements.txt

1. remove stale dependencies
2. remove sub dependencies
3. updated to latest dependencies

tests are not properly failing

this build should have failed

https://travis-ci.org/realpython/cookiecutter-flask-skeleton/jobs/351993978

add flask admin

add bootstrap 4

New click version breaks cli commands

with version 7.0, the click library developers changed the behavior for cli subcommands containing an underscore such that they are now exposed with a dash in place of the underscore. This means that instead of python manage.py create_db, the correct command is python manage.py create-db, etc.

When I have a few minutes available I'll submit a PR fixing the documentation to reflect this change.

add flake8

flask shell throws TypeError

Running a new project with minimal modifications from the template I kept receiving the following error when attempting to do flask shell:
TypeError: 'dict' object is not callable

Ultimately traced this to an issue in project/server/init.py

cookiecutter https://github.com/realpython/cookiecutter-flask-skeleton.git - asks for password?????

cookiecutter https://github.com/realpython/cookiecutter-flask-skeleton.git - asks for password?????

add cli tests

https://www.reddit.com/r/flask/comments/89f6by/af_how_do_i_test_my_cli_scripts/

update dockerfile to alpine

Add a license

This skeleton looks useful, and I'd like to be able to use it :) Could you add an MIT- or BSD-like license?

Add flake8

Add it as a CLI command. Run it during the Travis build.

ImportError: cannot import name 'url_encode'

when ran docker-compose up got the error ImportError: cannot import name 'url_encode' on the app container and it exits

docker compose up error

$ docker-compose up  --build
ERROR: Version in "./docker-compose.yml" is unsupported. 
You might be seeing this error because you're using the wrong Compose file version.
Either specify a version of "2" (or "2.0") and place your service definitions under the `services` key, 
or omit the `version` key and place your service definitions at the root of the file to use version 1.

$ sudo docker version
Client:
 Version:           18.06.1-ce
 API version:       1.38
 Go version:        go1.10.3
 Git commit:        e68fc7a
 Built:             Tue Aug 21 17:24:56 2018
 OS/Arch:           linux/amd64
 Experimental:      false

Server:
 Engine:
  Version:          18.06.1-ce
  API version:      1.38 (minimum version 1.12)
  Go version:       go1.10.3
  Git commit:       e68fc7a
  Built:            Tue Aug 21 17:23:21 2018
  OS/Arch:          linux/amd64
  Experimental:     false