flask/examples/flaskr
Kyle Lawlor 5f009374fd Update minitwit & improve testing for examples (#1954)
* Update minitwit & improve testing for examples

* Related to #1945
* Re-works minitwit to be installed and run as:

    pip install --editable .
    export FLASK_APP=minitwit.minitwit
    export FLASK_DEBUG=1
    flask initdb
    flask run

* added flaskr and minitwit to norecursedirs
  * tests not properly run when using pytest standards
  * see: http://stackoverflow.com/questions/38313171/configuring-pytest-with-installable-examples-in-a-project
* Both flaskr and minitwit now follow pytest standards.
* Tests can for them as `py.test` or `python setup.py test`

* Update minitwit readme

* updates the instructions for running

* Fixes for updating the minitwit example

- This reverts the changes to the *docs/* (I will file separate PR).
- Running the app is now: `export FLASK_APP=minitwit` & `flask run`
  (After installing the app)

* Remove unnecessary comma from flaskr/setup.py
2016-08-22 20:52:54 +02:00
..
flaskr Address #1902: Converts example/flaskr to have a setup.py (#1945) 2016-07-05 17:30:59 -07:00
tests Update minitwit & improve testing for examples (#1954) 2016-08-22 20:52:54 +02:00
.gitignore Address #1902: Converts example/flaskr to have a setup.py (#1945) 2016-07-05 17:30:59 -07:00
MANIFEST.in Address #1902: Converts example/flaskr to have a setup.py (#1945) 2016-07-05 17:30:59 -07:00
README Address #1902: Converts example/flaskr to have a setup.py (#1945) 2016-07-05 17:30:59 -07:00
setup.cfg Address #1902: Converts example/flaskr to have a setup.py (#1945) 2016-07-05 17:30:59 -07:00
setup.py Address #1902: Converts example/flaskr to have a setup.py (#1945) 2016-07-05 17:30:59 -07:00

                         / Flaskr /

                 a minimal blog application


    ~ What is Flaskr?

      A sqlite powered thumble blog application

    ~ How do I use it?

      1. edit the configuration in the flaskr.py file or
         export an FLASKR_SETTINGS environment variable
         pointing to a configuration file.

      2. install the app from the root of the project directory

         pip install --editable .

      3. Instruct flask to use the right application

         export FLASK_APP=flaskr.flaskr

      4. initialize the database with this command:

         flask initdb

      5. now you can run flaskr:

         flask run

         the application will greet you on
         http://localhost:5000/

    ~ Is it tested?

      You betcha.  Run `python setup.py test` to see
      the tests pass.