Skip to content
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.

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

documentation bug/ unittest mis-match: unittest assume global installation #2429

Open
aaronkaplan opened this issue Nov 28, 2023 · 1 comment
Labels
documentation Indicates a need for improvements or additions to documentation

Comments

@aaronkaplan
Copy link
Member

aaronkaplan commented Nov 28, 2023

Going through and testing the documentation, I noticed that the unittest discover instructions assume that we have a global installation.

If we follow the Developer guide, we might end up with a .venv installation.
(following: https://intelmq.readthedocs.io/en/develop/dev/guide.html)

Result:

(.venv) aaron@bee:/opt/dev_intelmq$ sudo -u intelmq python3 -m unittest discover
sudo: unknown user intelmq
@aaronkaplan aaronkaplan added the documentation Indicates a need for improvements or additions to documentation label Nov 28, 2023
@aaronkaplan aaronkaplan added this to the 3.2.2 milestone Nov 28, 2023
@aaronkaplan aaronkaplan modified the milestones: 3.2.2, 3.3.1 Feb 29, 2024
@sebix sebix removed this from the 3.3.1 milestone Aug 13, 2024
@sebix
Copy link
Member

sebix commented Aug 13, 2024

The docs already say, right above the code that you pasted and executed:

For virtual environment installation, please activate it and omit the sudo -u from examples below:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Indicates a need for improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants