forked from orbit-oss/flask
17d4cb3828
* Converts example/flaskr to have a setup.py Makes the flaskr app easier to run, ex. workflow: - pip install --editable . - export FLASK_APP=flaskr.flaskr - flask initdb - flask run Testing is also easier now: - python setup.py test * Fixed an import error in flaskr/tests - the statement `import flaskr` caused errors in python3 - `from . import flaskr` fixes the issue in 2.7.11 and 3.5.1 * Better project structure and updates the docs - Re-factors *flaskr*'s project structure a bit - Updates docs to make sense with the new structure - Adds a new step about installing Flask apps with setuptools - Switches first-person style writing to second-person (reads better IMO) - Adds segments in *testing.rst* for running tests with setuptools * Remove __init__.py from tests - py.test recommends not using __init__.py * Fix testing import errors
34 lines
1.3 KiB
ReStructuredText
34 lines
1.3 KiB
ReStructuredText
.. _tutorial-introduction:
|
|
|
|
Introducing Flaskr
|
|
==================
|
|
|
|
This tutorial will demonstrate a blogging application named Flaskr, but feel
|
|
free to choose your own less Web-2.0-ish name ;) Essentially, it will do the
|
|
following things:
|
|
|
|
1. Let the user sign in and out with credentials specified in the
|
|
configuration. Only one user is supported.
|
|
2. When the user is logged in, they can add new entries to the page
|
|
consisting of a text-only title and some HTML for the text. This HTML
|
|
is not sanitized because we trust the user here.
|
|
3. The index page shows all entries so far in reverse chronological order
|
|
(newest on top) and the user can add new ones from there if logged in.
|
|
|
|
SQLite3 will be used directly for this application because it's good enough
|
|
for an application of this size. For larger applications, however,
|
|
it makes a lot of sense to use `SQLAlchemy`_, as it handles database
|
|
connections in a more intelligent way, allowing you to target different
|
|
relational databases at once and more. You might also want to consider
|
|
one of the popular NoSQL databases if your data is more suited for those.
|
|
|
|
Here a screenshot of the final application:
|
|
|
|
.. image:: ../_static/flaskr.png
|
|
:align: center
|
|
:class: screenshot
|
|
:alt: screenshot of the final application
|
|
|
|
Continue with :ref:`tutorial-folders`.
|
|
|
|
.. _SQLAlchemy: http://www.sqlalchemy.org/
|