summaryrefslogtreecommitdiff
path: root/docs/tutorials/wiki/src/models/README.md
diff options
context:
space:
mode:
authorMichael Merickel <github@m.merickel.org>2024-02-07 20:52:05 -0700
committerGitHub <noreply@github.com>2024-02-07 20:52:05 -0700
commit53eb7e7cc6b7bfdedb4df4821af66619bebf909c (patch)
treec0244a2971d7fead848359f3d83fe158f8b509ad /docs/tutorials/wiki/src/models/README.md
parent151ebdc003a3a372017fdf73c14fbebcc550535d (diff)
parentfea81c0cf25402c7088b002be7a1672d29841345 (diff)
downloadpyramid-53eb7e7cc6b7bfdedb4df4821af66619bebf909c.tar.gz
pyramid-53eb7e7cc6b7bfdedb4df4821af66619bebf909c.tar.bz2
pyramid-53eb7e7cc6b7bfdedb4df4821af66619bebf909c.zip
Merge pull request #3751 from Pylons/tseaver-refresh-zodb-tutorial
docs: refresh ZODB wiki tutorial
Diffstat (limited to 'docs/tutorials/wiki/src/models/README.md')
-rw-r--r--docs/tutorials/wiki/src/models/README.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/tutorials/wiki/src/models/README.md b/docs/tutorials/wiki/src/models/README.md
new file mode 100644
index 000000000..d0126f5aa
--- /dev/null
+++ b/docs/tutorials/wiki/src/models/README.md
@@ -0,0 +1,40 @@
+# tutorial
+
+## 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]"
+ ```
+
+- Run your project's tests.
+
+ ```
+ env/bin/pytest
+ ```
+
+- Run your project.
+
+ ```
+ env/bin/pserve development.ini
+ ```