summaryrefslogtreecommitdiff
path: root/docs/narr/myproject/README.txt
blob: 41ef0ff91099da1ffb85d86969d263348621d6b1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
MyProject
===============================

Getting Started
---------------

- Change directory into your newly created project.

    cd MyProject

- Create a Python virtual environment.

    python3 -m venv env

- Upgrade packaging tools.

    env/bin/pip install --upgrade pip setuptools

- 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