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

Add requirements.txt file #10473

Closed
wants to merge 1 commit into from

Conversation

Mab879
Copy link
Member

@Mab879 Mab879 commented Apr 19, 2023

Description:

Add a requirements.txt file with the Python packages that are not in the Fedora repos.

Rationale:

Make it easier to install the python dependacies.

@rhmdnd rhmdnd self-requested a review April 19, 2023 17:33
@github-actions
Copy link

Start a new ephemeral environment with changes proposed in this pull request:

Fedora Environment
Open in Gitpod

Oracle Linux 8 Environment
Open in Gitpod

@codeclimate
Copy link

codeclimate bot commented Apr 19, 2023

Code Climate has analyzed commit a55b7eb and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (50% is the threshold).

This pull request will bring the total coverage in the repository to 52.4% (0.0% change).

View more on Code Climate.

@marcusburghardt marcusburghardt added this to the 0.1.68 milestone Apr 19, 2023
@marcusburghardt marcusburghardt added the Documentation Update in project documentation. label Apr 19, 2023
Copy link
Collaborator

@rhmdnd rhmdnd left a comment

Choose a reason for hiding this comment

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

Thanks for proposing this, Matt.

yamlpath
json2html
types-openpyxl
types-PyYAML
Copy link
Collaborator

Choose a reason for hiding this comment

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

Looks like we'll need:

  • PyYAML
  • jinja2
  • pandas (although this is from the tool I'm writing, so I can add it there if this lands first)
  • tables
  • openpyxl
  • pygments

Copy link
Member Author

@Mab879 Mab879 Apr 19, 2023

Choose a reason for hiding this comment

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

Looks like all of those packages are in the Fedora repos (and most are in RHEL). The current scope of this PR is only for packages not in Fedora. These would be good add to your PR in #10474.

PyYAML -> python3-pyyaml
jinja2 - > python3-jinja2
pandas -> python3-pandas
tables -> python3-tables That's not currently in our docs, can you cite which script needs this?
openpyxl -> python3-openpyxl
pygments -> python3-pygments, also not in our docs

Copy link
Collaborator

Choose a reason for hiding this comment

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

Ok - good deal. Thanks.

Copy link
Member

Choose a reason for hiding this comment

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

Don't be shy and add them as well - if you use pip install on a system where part of the requirements are already satisfied, they are simply skipped.

@Mab879
Copy link
Member Author

Mab879 commented Apr 19, 2023

Helps address #7988

@Mab879 Mab879 changed the title Add first requirements.txt file Add requirements.txt file Apr 19, 2023
@rhmdnd
Copy link
Collaborator

rhmdnd commented Apr 25, 2023

I have a patch for introducing a test-requirements.txt file, too #10487

Another approach we could take to help keep dependencies orthogonal would be to group scripts in directories. For example, we could have utils/build/ and utils/development/. The scripts dedicated to build pipelines or function would live in build/ and everything else necessary for helping contributors write and maintain content could live in development/.

From there, it would be relatively easy for contributors to have virtualenvs for dev and build separately (e.g., utils/development/requirements.txt). That may or may not be useful.

A side effect is that it would be nice to group like tools together, which may lead to efforts to consolidate functionality or consider moving to a unified, intuitive tool set for development.

@Mab879
Copy link
Member Author

Mab879 commented Apr 25, 2023

Succeed by #10487

@Mab879 Mab879 closed this Apr 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Update in project documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants