summaryrefslogtreecommitdiff
path: root/docs/tutorials/wiki2/src/tests/README.md
blob: 5ac1209d01ca10b6c08ed73477e1e3369de492f1 (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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
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
  ```