Browse Source

Merge branch 'master' of github.com:tracim/tracim_backend

Guénaël Muller 7 years ago
parent
commit
e246bcdb5d
1 changed files with 11 additions and 11 deletions
  1. 11 11
      README.md

+ 11 - 11
README.md View File

18
 
18
 
19
 ### Setup Python Virtualenv ###
19
 ### Setup Python Virtualenv ###
20
 
20
 
21
-- Go to *tracim* subdirectory:
21
+Go to *tracim* subdirectory:
22
 
22
 
23
     cd tracim
23
     cd tracim
24
 
24
 
25
-- Create a Python virtual environment:
25
+Create a Python virtual environment:
26
 
26
 
27
     python3 -m venv env
27
     python3 -m venv env
28
 
28
 
29
-- Activate it in your terminal session (**all tracim command execution must be executed under this virtual environment**):
29
+Activate it in your terminal session (**all tracim command execution must be executed under this virtual environment**):
30
 
30
 
31
     source env/bin/activate
31
     source env/bin/activate
32
 
32
 
33
-- Upgrade packaging tools:
33
+Upgrade packaging tools:
34
 
34
 
35
     pip install --upgrade pip setuptools
35
     pip install --upgrade pip setuptools
36
 
36
 
37
-- Install the project in editable mode with its testing requirements:
37
+Install the project in editable mode with its testing requirements:
38
 
38
 
39
     pip install -e ".[testing]"
39
     pip install -e ".[testing]"
40
 
40
 
41
 ### Configure Tracim_backend ###
41
 ### Configure Tracim_backend ###
42
 
42
 
43
-- Create configuration files for a development environment:
43
+Create configuration files for a development environment:
44
 
44
 
45
     cp development.ini.base development.ini
45
     cp development.ini.base development.ini
46
 
46
 
47
-- Initialize the database.
47
+Initialize the database.
48
 
48
 
49
     initialize_tracim_db development.ini
49
     initialize_tracim_db development.ini
50
 
50
 
51
 ### Run Tracim_backend ###
51
 ### Run Tracim_backend ###
52
 
52
 
53
-- Run your project:
53
+Run your project:
54
 
54
 
55
     pserve development.ini
55
     pserve development.ini
56
 
56
 
57
 ### Run Tests and others checks ###
57
 ### Run Tests and others checks ###
58
 
58
 
59
-- Run your project's tests:
59
+Run your project's tests:
60
 
60
 
61
     pytest
61
     pytest
62
 
62
 
63
-- Run mypy checks:
63
+Run mypy checks:
64
 
64
 
65
     mypy --ignore-missing-imports --disallow-untyped-defs tracim
65
     mypy --ignore-missing-imports --disallow-untyped-defs tracim
66
 
66
 
67
-- Run pep8 checks:
67
+Run pep8 checks:
68
 
68
 
69
     pep8 tracim
69
     pep8 tracim
70
 
70