@@ -43,11 +43,11 @@ pip install qctrl-open-controls
43
43
### From Source
44
44
45
45
The source code is hosted on
46
- [ Github ] ( https://github.com/qctrl/python- open-controls ) . The repository can be
46
+ [ GitHub ] ( https://github.com/qctrl/open-controls ) . The repository can be
47
47
cloned using
48
48
49
49
``` shell
50
- git clone
[email protected] :qctrl/
python- open-controls.git
50
+ git clone
[email protected] :qctrl/open-controls.git
51
51
```
52
52
53
53
Once the clone is complete, you have two options:
@@ -61,23 +61,22 @@ Once the clone is complete, you have two options:
61
61
After you have installed Poetry, use:
62
62
63
63
``` bash
64
- cd python- open-controls
64
+ cd open-controls
65
65
poetry install
66
66
```
67
67
68
68
1 . Using pip
69
69
70
70
``` shell
71
- cd python- open-controls
71
+ cd open-controls
72
72
poetry export --dev -f requirements.txt --output requirements.txt --without-hashes
73
73
pip install -r requirements.txt
74
74
pip install -e .
75
75
rm requirements.txt
76
76
```
77
77
78
78
Once installed via one of the above methods, test your installation by running
79
- ` pytest `
80
- in the ` python-open-controls ` directory.
79
+ ` pytest ` in the ` open-controls ` directory.
81
80
82
81
``` shell
83
82
pytest
@@ -129,7 +128,7 @@ Code is formatted, linted and checked using the following tools:
129
128
- [isort](https://github.com/timothycrosley/isort)
130
129
- [mypy](http://mypy-lang.org/)
131
130
132
- These checks are run on all code merged to master, and may also be run locally from the python- open-controls
131
+ These checks are run on all code merged to master, and may also be run locally from the open-controls
133
132
directory:
134
133
135
134
` ` ` shell
@@ -146,7 +145,7 @@ See the [official documentation](https://pylint.readthedocs.io/en/latest/user_gu
146
145
for details.
147
146
148
147
Black and isort, in addition to checking code, can also automatically apply fixes. To fix all code
149
- in the python- open-controls tree, run:
148
+ in the open-controls tree, run:
150
149
151
150
` ` ` shell
152
151
isort
@@ -166,13 +165,13 @@ With this, the checks will run every time that you commit code with
166
165
instead of when you commit changes, use ` pre-commit install -t pre-push` .
167
166
168
167
If you no longer wish to use ` pre-commit` , you can uninstall it by running
169
- ` pre-commit uninstall` in the ` python- open-controls` directory (or by running
168
+ ` pre-commit uninstall` in the ` open-controls` directory (or by running
170
169
` pre-commit uninstall -t pre-push` , if you used the pre-push hooks).
171
170
172
171
# # Credits
173
172
174
173
See
175
- [Contributors](https://github.com/qctrl/python- open-controls/graphs/contributors).
174
+ [Contributors](https://github.com/qctrl/open-controls/graphs/contributors).
176
175
177
176
# # License
178
177
0 commit comments