diff options
| author | Giampaolo Rodola <g.rodola@gmail.com> | 2017-04-25 11:15:39 +0200 |
|---|---|---|
| committer | Giampaolo Rodola <g.rodola@gmail.com> | 2017-04-25 11:15:39 +0200 |
| commit | 1ab8a0bff56163956a2140142481b83ddbfc8f3c (patch) | |
| tree | 3d2ba08a55b03ea352301b8a2702b2605eb82519 /DEVGUIDE.rst | |
| parent | 4f170f378cffe2dac03f591dcb31e74a48c64b5c (diff) | |
| download | psutil-1ab8a0bff56163956a2140142481b83ddbfc8f3c.tar.gz | |
update doc
Diffstat (limited to 'DEVGUIDE.rst')
| -rw-r--r-- | DEVGUIDE.rst | 22 |
1 files changed, 10 insertions, 12 deletions
diff --git a/DEVGUIDE.rst b/DEVGUIDE.rst index 93dfa690..2494816f 100644 --- a/DEVGUIDE.rst +++ b/DEVGUIDE.rst @@ -8,23 +8,21 @@ If you plan on hacking on psutil this is what you're supposed to do first: $ git clone git@github.com:giampaolo/psutil.git -- install system deps (see `install instructions <https://github.com/giampaolo/psutil/blob/master/INSTALL.rst>`__). - -- install development deps; these are useful for running tests (e.g. mock, - unittest2), building doc (e.g. sphinx), running linters (flake8), etc. :: +- install test deps and GIT hooks:: $ make setup-dev-env -- bear in mind that ``make`` (see `Makefile <https://github.com/giampaolo/psutil/blob/master/Makefile>`_) +- run tests:: + + $ make test + +- bear in mind that ``make`` + (see `Makefile <https://github.com/giampaolo/psutil/blob/master/Makefile>`_) is the designated tool to run tests, build, install etc. and that it is also available on Windows (see `make.bat <https://github.com/giampaolo/psutil/blob/master/make.bat>`_). -- bear in mind that both psutil (``make install``) and any other lib - (``make setup-dev-env``) is installed as a limited user - (``pip install --user ...``), so develop as such (don't use root). -- (UNIX only) run ``make install-git-hooks``: this will reject your commits - if python code is not PEP8 compliant. -- run ``make test`` to run tests. +- do not use ``sudo``; ``make install`` installs psutil as a limited user in + "edit" mode; also ``make setup-dev-env`` installs deps as a limited user. ============ Coding style @@ -43,7 +41,7 @@ Some useful make commands:: $ make install # install $ make setup-dev-env # install useful dev libs (pyflakes, unittest2, etc.) - $ make test # run all tests + $ make test # run unit tests $ make test-memleaks # run memory leak tests $ make coverage # run test coverage $ make flake8 # run PEP8 linter |
