Skip to content

Commit 214d775

Browse files
authored
Remove central makefile. (#916)
1 parent 62cb941 commit 214d775

File tree

4 files changed

+17
-86
lines changed

4 files changed

+17
-86
lines changed

Makefile

Lines changed: 0 additions & 70 deletions
This file was deleted.

README.rst

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -203,6 +203,7 @@ To get a specific version:
203203
git checkout tags/vX.Y.Z -b vX.Y.Z
204204

205205
Then::
206+
pip install -r requirements.txt
206207
pip install -e .
207208
208209
This installs pymodbus in your virtual environment with pointers directly to the pymodbus directory, so any change you make is imidiatly available as if installed.
@@ -237,7 +238,6 @@ That said, the current work mainly involves polishing the library and
237238
solving issues:
238239

239240
* Get version 3.0.0 released
240-
* Make PEP-8 compatible and pylint, flake8, black and mypy ready
241241
* Fixing bugs/feature requests
242242
* Architecture documentation
243243
* Functional testing against any reference we can find
@@ -247,21 +247,27 @@ solving issues:
247247
Development Instructions
248248
------------------------------------------------------------
249249
The current code base is compatible python >= 3.8.
250-
Use make to perform a range of activities
250+
Here are some of the common commands to perform a range of activities
251251

252252
::
253+
pip install -r requirements.txt install all requirements
254+
pip install -e . source directory is "release", usefull for testing
253255

254-
$ make
255-
Makefile for pymodbus
256+
tox -e py38 (or py39, py310, pypy38) Run pytest on source code
256257

257-
Usage:
258+
tox -e pylint Run pylint on source code
259+
tox -e codespell Run codespell on source code
260+
tox -e bandit Run bandit on source code
261+
tox -e flake8 Run flake8 on source code
262+
tox -e black Run black on source code
258263

259-
make install install the package in a virtual environment
260-
make reset recreate the virtual environment
261-
make check check coding style (PEP-8, PEP-257)
262-
make test run the test suite, report coverage
263-
make tox run the tests on all Python versions
264-
make clean cleanup all temporary files
264+
------------------------------------------------------------
265+
Generate documentation
266+
------------------------------------------------------------
267+
::
268+
cd doc
269+
make clean
270+
make html
265271

266272
------------------------------------------------------------
267273
Contributing

TODO_add_checks

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
1) add .pre-commit and commit-hook
22

33
2) new checks
4-
- flake8 addons:
5-
pycodestyle
6-
pydocstyle
7-
84
- prettier
95
- mypy
106

doc/TODO

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ General
66
- add all modbus control into server
77
- add correct transaction handling (retry, fail, etc)
88
- Test/update examples
9-
- update code to satisfy black
109
- update code to satisfy mypy
1110
- get coverage > 98%
1211
- clean raise to be at frame level

0 commit comments

Comments
 (0)