[DOC] Update documentation for running tests with local services
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 74/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- docker, docker-compose, python
- Domain
- documentation
Research direction
Start with the documentation section covering local service setup and the testing guide. Compare the existing instructions with the local-service changes in PRs #1629 and #1697, then document the required permission steps and running pytest with OPENML_USE_LOCAL_SERVICES; done means contributors can follow both workflows without using the remote test server.
Written by the indexing model from the issue text.
Description
We recently switched the CI to run tests against local services using Docker instead of the remote test server. This change was introduced in:
The documentation should now be updated to explain how contributors can run the test suite using these local services.
Proposed changes:
-
Update local service setup
In the documentation for starting the local services, add the additional permission setup steps required before running
docker compose, as implemented in #1697. -
Update the testing guide
Extend the test guide with instructions on how to run pytest against the local services.
This requires setting the environment variable:OPENML_USE_LOCAL_SERVICES
- Dominant language
- Python
- Stars
- 361
- Forks
- 296
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from openml/openml-python
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
openml/openml-python#1749 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
openml/openml-python#1746 ·
-
Good First Issue module:Run testing
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
openml/openml-python#1646 · 7 comments · 2 reactions ·
-
Good First Issue module:Data testing
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
openml/openml-python#1644 · 4 comments ·
-
Documentation
openml/openml-python#1744 · 1 comment · 1 assignee ·
All issues in openml/openml-python
Similar issues
-
Add: hunch Open
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
AbdelStark/awesome-typesafe#104 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
DiamondLightSource/dodal#2211 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
sipyourdrink-ltd/bernstein#6191 ·
-
security severity:low track:open-source
Difficulty 2/5 1-3 hours Newbie friendliness 78/100