From 948577c10e7fe0f645d9699d1cd0bbca351cc9bd Mon Sep 17 00:00:00 2001 From: Tres Seaver Date: Wed, 7 Feb 2024 11:06:48 -0500 Subject: 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. --- docs/tutorials/wiki/src/basiclayout/README.md | 40 +++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 docs/tutorials/wiki/src/basiclayout/README.md (limited to 'docs/tutorials/wiki/src/basiclayout/README.md') diff --git a/docs/tutorials/wiki/src/basiclayout/README.md b/docs/tutorials/wiki/src/basiclayout/README.md new file mode 100644 index 000000000..d0126f5aa --- /dev/null +++ b/docs/tutorials/wiki/src/basiclayout/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 + ``` -- cgit v1.2.3