Changeset View
Changeset View
Standalone View
Standalone View
docs/developer-setup.rst
| Show First 20 Lines • Show All 82 Lines • ▼ Show 20 Lines | .. Note:: the above assumes you are using virtualenvwrapper_ to manage your | ||||
| virtualenvs, or any other virtualenv management tool (pipenv_ or poetry_ for | virtualenvs, or any other virtualenv management tool (pipenv_ or poetry_ for | ||||
| example). virtualenvwrapper_ is our preference, but YMMV. | example). virtualenvwrapper_ is our preference, but YMMV. | ||||
| .. _virtualenvwrapper: https://virtualenvwrapper.readthedocs.io/ | .. _virtualenvwrapper: https://virtualenvwrapper.readthedocs.io/ | ||||
| .. _poetry: https://poetry.eustace.io/ | .. _poetry: https://poetry.eustace.io/ | ||||
| .. _pipenv: https://pipenv.readthedocs.io/ | .. _pipenv: https://pipenv.readthedocs.io/ | ||||
| Install all the swh packages (in develop mode):: | Install all the swh packages (in development mode, with testing dependencies):: | ||||
| (swh) ~/swh-environment$ pip install flake8 pifpaf tox wheel mypy | (swh) ~/swh-environment$ bin/install | ||||
| (swh) ~/swh-environment$ pip install $(./bin/pip-swh-packages) | |||||
| (swh) ~/swh-environment$ pip install $(./bin/pip-swh-packages --with-testing) | |||||
| [...] | [...] | ||||
| .. Note:: If you experience issues in :program:`pip` package resolution, try using | .. note:: | ||||
| ``--use-deprecated=legacy-resolver`` CLI option. | |||||
| It can be set in :file:`~/.config/pip/pip.conf` until the issue is solved:: | If you experience issues with :program:`pip` dependency resolution, try with | ||||
| ``bin/install --use-deprecated=legacy-resolver`` (the flag will be passed on | |||||
| to :program:`pip install`). The same flag can also be set globally in | |||||
| :file:`~/.config/pip/pip.conf`:: | |||||
| [install] | [install] | ||||
| use-deprecated=legacy-resolver | use-deprecated=legacy-resolver | ||||
| Executing unit tests | Executing unit tests | ||||
| -------------------- | -------------------- | ||||
| Unit tests are using the pytest_ framework, and can be executed directly or via | Unit tests are using the pytest_ framework, and can be executed directly or via | ||||
| tox_. The main difference between these 2 test execution environments is: | tox_. The main difference between these 2 test execution environments is: | ||||
| - When executed via tox_, all the dependencies (including swh ones) are | - When executed via tox_, all the dependencies (including swh ones) are | ||||
| installed from pypi_: you test your modifications against the latest | installed from pypi_: you test your modifications against the latest | ||||
| ▲ Show 20 Lines • Show All 130 Lines • Show Last 20 Lines | |||||