summaryrefslogtreecommitdiff
path: root/docs/tutorials/wiki2/src/authentication/README.md
diff options
context:
space:
mode:
authorMichael Merickel <michael@merickel.org>2024-02-04 16:14:01 -0700
committerMichael Merickel <michael@merickel.org>2024-02-04 16:14:01 -0700
commit286a7a3ee8705b28fb82252daa37896d63ae6741 (patch)
tree377c4dcd4095446eeb75c365e37cb2c08493b0ab /docs/tutorials/wiki2/src/authentication/README.md
parentd3c8d93cfb1282f328ecd133df6565a2df92779f (diff)
downloadpyramid-286a7a3ee8705b28fb82252daa37896d63ae6741.tar.gz
pyramid-286a7a3ee8705b28fb82252daa37896d63ae6741.tar.bz2
pyramid-286a7a3ee8705b28fb82252daa37896d63ae6741.zip
update authentication chapter
Diffstat (limited to 'docs/tutorials/wiki2/src/authentication/README.md')
-rw-r--r--docs/tutorials/wiki2/src/authentication/README.md60
1 files changed, 60 insertions, 0 deletions
diff --git a/docs/tutorials/wiki2/src/authentication/README.md b/docs/tutorials/wiki2/src/authentication/README.md
new file mode 100644
index 000000000..5ac1209d0
--- /dev/null
+++ b/docs/tutorials/wiki2/src/authentication/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
+ ```