Skip to content

docs(packaging): switch install docs to pyproject workflows#64

Open
saquibsaifee wants to merge 5 commits intoGenAI-Security-Project:mainfrom
saquibsaifee:docs/remove-requirements.txt
Open

docs(packaging): switch install docs to pyproject workflows#64
saquibsaifee wants to merge 5 commits intoGenAI-Security-Project:mainfrom
saquibsaifee:docs/remove-requirements.txt

Conversation

@saquibsaifee
Copy link
Copy Markdown
Contributor

@saquibsaifee saquibsaifee commented Feb 27, 2026

Summary

  • Use pyproject.toml as the single source of truth for all dependencies (core + dev extras)
  • requirements.txt is now a generated artifact produced by uv pip compile pyproject.toml -o requirements.txt
  • Document the regeneration workflow in CONTRIBUTING.md so contributors know to run uv pip compile and uv lock before committing dependency changes

Changed files

  • CONTRIBUTING.md — updated directory tree to include requirements.txt; added "Updating Dependencies" section with uv pip compile and uv lock commands
  • requirements.txt — restored as a pinned, annotated file generated from pyproject.toml
  • uv.lock — added lock file for reproducible installs

@saquibsaifee saquibsaifee marked this pull request as draft March 27, 2026 12:29
@saquibsaifee saquibsaifee marked this pull request as ready for review April 15, 2026 01:48
…pyproject.toml

Keep requirements.txt for compatibility with upstream tools, CI systems,
and contributors familiar with the file. pyproject.toml remains the source
of truth — contributors regenerate requirements.txt via `uv pip compile`
and sync uv.lock via `uv lock` before committing dependency changes.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Signed-off-by: Saquib Saifee <saquibsaifee2@gmail.com>
@saquibsaifee saquibsaifee force-pushed the docs/remove-requirements.txt branch from a99b77a to 9178182 Compare April 15, 2026 02:17
Signed-off-by: Saquib Saifee <saquibsaifee2@gmail.com>
Signed-off-by: Saquib Saifee <saquibsaifee2@gmail.com>
@saquibsaifee
Copy link
Copy Markdown
Contributor Author

@eaglei15 this is ready now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant