summaryrefslogtreecommitdiff
path: root/docs/tutorials/wiki/src/tests/README.md
diff options
context:
space:
mode:
authorTres Seaver <tseaver@palladion.com>2024-02-07 11:06:48 -0500
committerTres Seaver <tseaver@palladion.com>2024-02-07 11:08:35 -0500
commit948577c10e7fe0f645d9699d1cd0bbca351cc9bd (patch)
tree581b257169afdd44aed754cd6945afdd4e8659dc /docs/tutorials/wiki/src/tests/README.md
parent5229e501acd802e90220c754e4c09de582967bbd (diff)
downloadpyramid-948577c10e7fe0f645d9699d1cd0bbca351cc9bd.tar.gz
pyramid-948577c10e7fe0f645d9699d1cd0bbca351cc9bd.tar.bz2
pyramid-948577c10e7fe0f645d9699d1cd0bbca351cc9bd.zip
chore: sync with cookiecutter:
- Use 'pyproject.toml' rather than 'setup.py', 'pytest.ini', '.coveragerg'. - Drop 'CHANGES.txt': implementing that in 'pyproject.toml' is a distraction. - Convert README to Markdown.
Diffstat (limited to 'docs/tutorials/wiki/src/tests/README.md')
-rw-r--r--docs/tutorials/wiki/src/tests/README.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/tutorials/wiki/src/tests/README.md b/docs/tutorials/wiki/src/tests/README.md
new file mode 100644
index 000000000..d0126f5aa
--- /dev/null
+++ b/docs/tutorials/wiki/src/tests/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
+ ```