[Bug Report] CONTRIBUTING.md guide needs work
chrisyeh96 opened this issue · 2 comments
chrisyeh96 commented
Describe the bug
I tried following the CONTRIBUTING.md guide to run pytest
but it does not work.
I first did the following, which worked.
sudo apt update
sudo apt install swig
pip install -e .[all]
Then I tried running pytest
but I received the following error message:
/workspaces/PettingZoo $ pytest -v
ERROR: usage: pytest [options] [file_or_dir] [file_or_dir] [...]
pytest: error: unrecognized arguments: -n=auto
inifile: /workspaces/PettingZoo/pyproject.toml
rootdir: /workspaces/PettingZoo
I also tried using make test-all
:
/workspaces/PettingZoo $ make test-all
pytest -v --cov=pettingzoo --cov-report term
ERROR: usage: pytest [options] [file_or_dir] [file_or_dir] [...]
pytest: error: unrecognized arguments: -n=auto --cov=pettingzoo --cov-report
inifile: /workspaces/PettingZoo/pyproject.toml
rootdir: /workspaces/PettingZoo
make: *** [Makefile:11: test-all] Error 4
Code example
No response
System info
I installed PettingZoo in the default GitHub codespace configuration.
Additional context
No response
Checklist
- I have checked that there is no similar issue in the repo
elliottower commented
Oh my fault i forgot to add pytest xdist to the pyproject dependencies, it allows distributed testing. Could you include it in one of your prs?
chrisyeh96 commented
I think the issue might be instead that CONTRIBUTING.md should say
pip install -e .[testing,all]
instead of
pip install -e .[all]
In pyproject.toml, it seems like the all
option does not include any of the testing-related dependencies.
I've made a pull request with this change: #1097