Commit graph

22 commits

Author SHA1 Message Date
John Braun
c40974bf11
Add disclaimer for proper error message handling
As the Flask tutorial explicitly returns messages that might reveal useful information to potential attackers, a section was added to raise awareness that in a real world application the reader might want to use more generic error messages as advised by the OWASP project (a link to the documentation of OWASP is provided).
2022-10-31 21:12:17 +01:00
Angeline
5119657547
safer check for existing user in tutorial
Co-authored-by: David Lord <davidism@gmail.com>
2021-08-05 18:01:55 -07:00
David Lord
2ae740dd49
f-strings everywhere 2020-04-04 12:10:00 -07:00
cktan98
f45ceec31f Fix grammatical error 2018-07-25 01:57:30 +08:00
David Lord
c3dd7b8e4c
rewrite tutorial docs and example 2018-04-09 00:53:25 -07:00
Dave Morse
50c6df7098 Minor edits to tutorial for clarity. (#2330) 2017-05-24 17:00:20 -07:00
Kyle Lawlor
e6f9d2b414 Clean up tutorial docs for installable app pattern with flaskr (#2002)
* Clean up tutorial docs for installable app pattern

- reading sequentially through the tutorial works.
- fixes references to `export FLASK_APP=flaskr.flaskr`

* Fixes titles for each section of flaskr tutorial

* Revert grammar

* Emphasize the Packaging Guide

- adds more general packaging resource
- removes the emphasis put on setuptools

* rephrase and remove note admonitions

- expanded on few points
- removed note blocks, they are unneccessary

* Remove note about reinstalling to update cli

- I had mistakenly thought it was necessary to
  re-install the app to update the cli.
- the `--editable` flag detects the change and
  the cli updates without issue.
2016-09-08 15:19:48 +02:00
Kyle Lawlor
17d4cb3828 Address #1902: Converts example/flaskr to have a setup.py (#1945)
* 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
2016-07-05 17:30:59 -07:00
Winston Kouch
594d1c5eb2 Add note to not use plain text passwords to views.rst 2016-04-05 18:53:08 +02:00
bagratte
9a80fe691d minor revision of documentation. 2016-04-01 23:12:25 +02:00
Kevin Yap
23fc2e56a8 Grammatical fixes in Foreword and Tutorial 2014-12-16 11:30:00 -08:00
defuz
a8f570cc62 docs: :file:app.py, :file:yourapp/templates 2014-11-05 06:45:22 +03:00
defuz
3fa4fd0908 docs: http method names like `GET and POST` 2014-11-05 06:13:01 +03:00
defuz
8284217593 docs: `True, False and None` 2014-11-05 06:04:58 +03:00
Armin Ronacher
05161d3584 Rewrote tutorial to use the g based appcontext object 2013-09-01 01:32:41 +06:00
Armin Ronacher
22d468e190 Less annoying gender neutral forms 2011-06-28 14:34:07 +02:00
Jeffrey Finkelstein
12761bd02c fixed pronoun gender in documentation 2011-06-26 21:43:48 -04:00
Ron DuPlain
b4b2f42f48 Warn about SQL injection in the tutorial. 2010-07-16 04:57:18 +08:00
Adam Zapletal
5ede53066f Minor tutorial documentation fixes (grammar, etc) 2010-06-28 15:12:32 +08:00
Armin Ronacher
dfecc86dd3 Ported examples over to new config. documented upgrading 2010-05-27 21:17:25 +02:00
Armin Ronacher
9d19b77acf Added lazyloading pattern and explicit chapter links in tutorial.
This fixes #49.
2010-05-26 14:49:01 +02:00
Armin Ronacher
bcf347fe8d New style for the documentation. Looks more like the website now. 2010-04-18 13:15:00 +02:00