Skip to content

Add test running instructions to README #107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zache-fi wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add test running instructions to README #107

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,13 @@ To modify the code and test it locally, you'll need to install it as a pip packa
ukbot --page Bruker:Danmichaelo/Sandkasse5 --simulate config/config.no-mk.yml


## Howto run tests
Copy link

Copilot AI Apr 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Heading "Howto run tests" is grammatically incorrect/inconsistent with other sections (e.g., "Getting Started"). Consider renaming to "How to run tests" for clarity and consistency.

Suggested change
## Howto run tests
## How to run tests

Copilot uses AI. Check for mistakes.

python3 -m venv venv
source venv/bin/activate
Comment on lines +67 to +68
Copy link

Copilot AI Apr 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These test instructions create/activate a different virtualenv path ("venv/") than the one used in "Getting Started" ("www/python/venv"). This is likely to confuse contributors; consider reusing the same path (or explicitly stating that the existing env from Getting Started can be reused) and using the same activation command style (". /bin/activate" vs "source").

Suggested change
python3 -m venv venv
source venv/bin/activate
python3 -m venv www/python/venv
. www/python/venv/bin/activate

Copilot uses AI. Check for mistakes.
pip install -r requirements.txt
pip install .
Copy link

Copilot AI Apr 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CI config (.travis.yml) currently runs tests via "pytest -v", but README instructs using "python3 -m unittest discover". Since this repository's tests are compatible with both, consider aligning the README with the CI command (or mention both options) to reduce confusion when reproducing CI locally.

Suggested change
pip install .
pip install .
pytest -v
If you prefer the standard library test runner, the test suite is also compatible with:

Copilot uses AI. Check for mistakes.
python3 -m unittest discover -s test -v

## Deployment

Expand Down