diff options
Diffstat (limited to 'docs/tutorials/wiki2/src/basiclayout/README.md')
| -rw-r--r-- | docs/tutorials/wiki2/src/basiclayout/README.md | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/docs/tutorials/wiki2/src/basiclayout/README.md b/docs/tutorials/wiki2/src/basiclayout/README.md new file mode 100644 index 000000000..5ac1209d0 --- /dev/null +++ b/docs/tutorials/wiki2/src/basiclayout/README.md @@ -0,0 +1,60 @@ +# myproj + +## Getting Started + +- Change directory into your newly created project if not already there. Your + current directory should be the same as this `README.md` file and `pyproject.toml`. + + ``` + cd tutorial + ``` + +- Create a Python virtual environment, if not already created. + + ``` + python3 -m venv env + ``` + +- Upgrade packaging tools, if necessary. + + ``` + env/bin/pip install --upgrade pip + ``` + +- Install the project in editable mode with its testing requirements. + + ``` + env/bin/pip install -e ".[testing]" + ``` + +- Initialize and upgrade the database using Alembic. + + - Generate your first revision. + + ``` + env/bin/alembic -c development.ini revision --autogenerate -m "init" + ``` + + - Upgrade to that revision. + + ``` + env/bin/alembic -c development.ini upgrade head + ``` + +- Load default data into the database using a script. + + ``` + env/bin/initialize_tutorial_db development.ini + ``` + +- Run your project's tests. + + ``` + env/bin/pytest + ``` + +- Run your project. + + ``` + env/bin/pserve development.ini + ``` |
