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 PyYAML dependency to docs and setup.py #7

Closed
EdwardLarson opened this issue Aug 15, 2022 · 0 comments
Closed

Add PyYAML dependency to docs and setup.py #7

EdwardLarson opened this issue Aug 15, 2022 · 0 comments
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@EdwardLarson
Copy link
Collaborator

EdwardLarson commented Aug 15, 2022

OFRAK has PyYAML dependencies in three places which are not explicit in code or documentation:

  • ofrak_ghidra requires it
  • build_image.py requires it for the Docker build system
  • Building the OFRAK docs requires PyYAML

These three dependencies should be handled separately:

  • ofrak_ghidra's setup.py shall include PyYAML
  • INSTALL.md will explain that PyYAML is required for the Docker build
  • PyYAML will be included in the docs requirements in the extras_require section for the core ofrak package.

Originally posted by @joshterrill in #6 (comment)

@EdwardLarson EdwardLarson added bug Something isn't working documentation Improvements or additions to documentation labels Aug 15, 2022
@EdwardLarson EdwardLarson self-assigned this Aug 15, 2022
marczalik pushed a commit to marczalik/ofrak that referenced this issue Mar 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant