summaryrefslogtreecommitdiff
path: root/docs/quick_tour/sqla_demo/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'docs/quick_tour/sqla_demo/README.txt')
-rw-r--r--docs/quick_tour/sqla_demo/README.txt31
1 files changed, 25 insertions, 6 deletions
diff --git a/docs/quick_tour/sqla_demo/README.txt b/docs/quick_tour/sqla_demo/README.txt
index b6d4c7798..1659e47ab 100644
--- a/docs/quick_tour/sqla_demo/README.txt
+++ b/docs/quick_tour/sqla_demo/README.txt
@@ -1,14 +1,33 @@
-sqla_demo README
-==================
+sqla_demo
+===============================
Getting Started
---------------
-- cd <directory containing this file>
+- Change directory into your newly created project.
-- $VENV/bin/pip install -e .
+ cd sqla_demo
-- $VENV/bin/initialize_sqla_demo_db development.ini
+- Create a Python virtual environment.
-- $VENV/bin/pserve development.ini
+ python3 -m venv env
+- Upgrade packaging tools.
+
+ env/bin/pip install --upgrade pip setuptools
+
+- Install the project in editable mode with its testing requirements.
+
+ env/bin/pip install -e ".[testing]"
+
+- Configure the database.
+
+ env/bin/initialize_sqla_demo_db development.ini
+
+- Run your project's tests.
+
+ env/bin/pytest
+
+- Run your project.
+
+ env/bin/pserve development.ini