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.

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

Jump to bottom

Make python requirements more obvious #107

Merged
merged 2 commits into from
Oct 14, 2024
Merged

Make python requirements more obvious #107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
587528b
make it clearer in README where python requirements are documented
mikemorency Oct 10, 2024
1f53c19
changelog
mikemorency Oct 10, 2024
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
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ It focuses on playbooks and roles that allow users to quickly and easily perform

This repository comes with an execution environment definition. This can be used to quickly build a container image that contains all of the software required to run the playbooks and roles in this repository. See [execution-environment/README.md](https://github.com/redhat-cop/cloud.vmware_ops/tree/main/execution-environment/README.md) for more information.

It is common for people to use `localhost` to run the tasks in this content since most tasks simply interact with the vSphere environment. If you do not use the execution environment, the following requirements are needed on whatever host runs the tasks:
### Python Requirements

It is common for people to use `localhost` to run the tasks in this content since most tasks simply interact with the vSphere environment. If you do not use the execution environment mentioned above, the following requirements are needed on whatever host runs the tasks:
- Python 3.9 or greater
- Python requirements found in [execution-environment/requirements.txt](https://github.com/redhat-cop/cloud.vmware_ops/tree/main/execution-environment/requirements.txt)
Copy link
Collaborator

Choose a reason for hiding this comment

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

for integration tests used another requirements.txt (https://github.com/redhat-cop/cloud.vmware_ops/blob/main/tests/integration/requirements.txt). Should it be the same?

Copy link
Collaborator Author

@mikemorency mikemorency Oct 14, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

I dont think it should be the same.
It looks like there is a lot of overlap between the two which probably isnt great. Maybe during test setup we should install the requirements from the EE directory first and then the requirements.txt in the tests directory can be anything else that just the tests need. For example, podman is just needed by the integration tests and would not make sense for a regular user to install
Ill make a ticket for that


Expand Down
3 changes: 3 additions & 0 deletions changelogs/fragments/107-document-python-requirements.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
bugfixes:
- Made it clearer in the collection README where python requirements are documented
Loading