[TESTING.md] Enhance TESTING docs with Editor/IDE-Specific Tweaks & Tips
See original GitHub issuePer https://github.com/exercism/exercism/issues/5791 and other comments and discussions, it has become clear that students could use some additional detail/help with setting up PyTest locally and running tests from their particular IDEs. It might also be nice to give students links to plugins or default config files to ease their setup for a given editor.
This would be for Python 3.8
and above only, and would entail changing/revising:
- TESTS.md file that is downloaded as part of the CLI, and displayed on the website here: Testing on the Python Track.
- The shared test file
- TOOLS.md, which really really needs updating.
We can’t cover all OS and IDE combinations, but we should cover the major ones if we can. In particular:
- PyCharm (free, paid, edu) on Linux, Mac, and Windows
- VS Code on Linux, Mac, Windows
- Spyder on Linux, Mac, Windows
- possibly Sublime, though lower priority
- possibly JupyterLab, but also lower priority
Additionally, we should have tips on how things change inside a venv/conda env
, how they might work inside docker
, and how those methods differ from having PyTest
installed globally (which is what the instructions assume at the moment). An example of some of this information given for Spyder 4.1.5
is in the comments of issue linked at the top.
Issue Analytics
- State:
- Created 2 years ago
- Comments:5 (5 by maintainers)
Top GitHub Comments
WOOO HOOO! So happy we’re able to close this! NICE WORK!
Heya, I would love to work on this.
TESTS.md I can already see some of the work that has to be done TESTS.md such as a more concise tutorial on installing and using Pytest, since, my assumption, is that most students just want to know how to test their solutions locally. Maybe adding a few options which will help them debug their solutions is good. Possibly out of scope: We could also add a tutorial about creating your own tests, and how to understand the test files themselves. Could be useful?
Shared testing file For the shared testing file, just make sure the basics of testing are in there. Maybe just have a link to TOOLS.md, instead of having links to the downloads of IDEs (most IDEs mentioned do not come out-of-the-box with testing integration installed).
TOOLS.md Will expand TOOLS.md with tutorials to more IDEs and editors (the ones listed in the requirements). I am not fluent with Spyder (used it before though), and have never used JupyterLab before, but I am willing to do that. Will update (if needed) the Visual Studio tutorial, and also make new tutorials, with pictures, for the rest of the IDEs/editors. Could also add handy/recommended extensions for some or all of the IDEs/editors.
Tips and tricks on things changing inside could be a separate subject in TESTING.md, will probably do this last though. Am planning to get this done before we post the new/updated files.
What do you think? Any other additions?