flask/examples/flaskr/README

                         / 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 factory.py file or
         export an FLASKR_SETTINGS environment variable
         pointing to a configuration file or pass in a
         dictionary with config values using the create_app
         function.

      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.factory:create_app()

      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.
Removed useless imports and added README 2010-04-14 16:47:53 +02:00			`/ Flaskr /`

			`a minimal blog application`


Fixed a typo 2010-04-14 17:09:34 +02:00			`~ What is Flaskr?`
Removed useless imports and added README 2010-04-14 16:47:53 +02:00
			`A sqlite powered thumble blog application`

			`~ How do I use it?`

Add in a fixture utilizing app factory 2017-04-02 11:55:05 -04:00			`1. edit the configuration in the factory.py file or`
Ported examples over to new config. documented upgrading 2010-05-27 21:17:25 +02:00			`export an FLASKR_SETTINGS environment variable`
i think this is how this works now 2017-05-25 18:01:52 -04:00			`pointing to a configuration file or pass in a`
Add in a fixture utilizing app factory 2017-04-02 11:55:05 -04:00			`dictionary with config values using the create_app`
			`function.`
Removed useless imports and added README 2010-04-14 16:47:53 +02:00
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 20:30:59 -04:00			`2. install the app from the root of the project directory`
Updated the examples to be cli based 2014-04-29 01:48:31 +02:00
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 20:30:59 -04:00			`pip install --editable .`
Updated the examples to be cli based 2014-04-29 01:48:31 +02:00
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 20:30:59 -04:00			`3. Instruct flask to use the right application`

i think this is how this works now 2017-05-25 18:01:52 -04:00			`export FLASK_APP=flaskr.factory:create_app()`
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 20:30:59 -04:00
			`4. initialize the database with this command:`
Updated the examples to be cli based 2014-04-29 01:48:31 +02:00
Update docs to the new CLI patterns 2016-05-26 20:45:50 +02:00			`flask initdb`

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 20:30:59 -04:00			`5. now you can run flaskr:`
Update docs to the new CLI patterns 2016-05-26 20:45:50 +02:00
			`flask run`
Updated the examples to be cli based 2014-04-29 01:48:31 +02:00
			`the application will greet you on`
			`http://localhost:5000/`
docs: :file:`app.py`, :file:`yourapp/templates` 2014-11-05 06:45:22 +03:00
Removed useless imports and added README 2010-04-14 16:47:53 +02:00			`~ Is it tested?`

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 20:30:59 -04:00			You betcha. Run `python setup.py test` to see
Removed useless imports and added README 2010-04-14 16:47:53 +02:00			`the tests pass.`