@@ -51,25 +51,33 @@ We expect you to use a python virtual environment to run our tests.
51
51
52
52
There are several ways to make a virtual environment.
53
53
54
- If you like to use *virtualenv * please run::
54
+ If you like to use *virtualenv * please run:
55
+
56
+ .. code-block :: sh
55
57
56
58
$ cd aiomysql
57
- $ virtualenv --python=`which python3` venv
59
+ $ virtualenv --python=" $( which python3) " venv
60
+
61
+ For standard python *venv *:
58
62
59
- For standard python * venv *::
63
+ .. code-block :: sh
60
64
61
65
$ cd aiomysql
62
66
$ python3 -m venv venv
63
67
64
- For *virtualenvwrapper *::
68
+ For *virtualenvwrapper *:
69
+
70
+ .. code-block :: sh
65
71
66
72
$ cd aiomysql
67
- $ mkvirtualenv --python=` which python3` aiomysql
73
+ $ mkvirtualenv --python=" $( which python3) " aiomysql
68
74
69
75
There are other tools like *pyvenv * but you know the rule of thumb
70
76
now: create a python3 virtual environment and activate it.
71
77
72
- After that please install libraries required for development::
78
+ After that please install libraries required for development:
79
+
80
+ .. code-block :: sh
73
81
74
82
$ pip install -r requirements-dev.txt
75
83
@@ -83,7 +91,7 @@ use this values by default. But you always can override host/port, user and
83
91
password in `aiomysql/tests/base.py ` file or install corresponding environment
84
92
variables. Tests require two databases to be created before running suit:
85
93
86
- ::
94
+ .. code-block :: sh
87
95
88
96
$ mysql -u root
89
97
mysql> CREATE DATABASE test_pymysql DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_general_ci;
@@ -94,7 +102,9 @@ Run aiomysql test suite
94
102
-----------------------
95
103
96
104
After all the preconditions are met you can run tests typing the next
97
- command::
105
+ command:
106
+
107
+ .. code-block :: sh
98
108
99
109
$ make test
100
110
@@ -113,7 +123,9 @@ Tests coverage
113
123
114
124
We are trying hard to have good test coverage; please don't make it worse.
115
125
116
- Use::
126
+ Use:
127
+
128
+ .. code-block :: sh
117
129
118
130
$ make cov
119
131
@@ -130,7 +142,9 @@ Documentation
130
142
131
143
We encourage documentation improvements.
132
144
133
- Please before making a Pull Request about documentation changes run::
145
+ Please before making a Pull Request about documentation changes run:
146
+
147
+ .. code-block :: sh
134
148
135
149
$ make doc
136
150
0 commit comments