Skip to content

Add requirements.txt for Python dependencies - #2510

Open
charishma1407 wants to merge 3 commits into
open-quantum-safe:mainfrom
charishma1407:charishma_requirements_txt
Open

Add requirements.txt for Python dependencies#2510
charishma1407 wants to merge 3 commits into
open-quantum-safe:mainfrom
charishma1407:charishma_requirements_txt

Conversation

@charishma1407

Copy link
Copy Markdown

Purpose:
This PR adds requirements.txt file for installing python dependencies.
Updated README.md as per the requirements in Ubuntu and MacOs.

Checklist

  1. Does this PR change the input/output behaviour of a cryptographic algorithm (i.e., does it change known answer test values)? (If so, a version bump will be required from x.y.z to x.(y+1).0.)
    No This PR is a document and dependency change only
  2. Does this PR change the list of algorithms available -- either adding, removing, or renaming? Does this PR otherwise change an API? (If so, PRs in fully supported downstream projects dependent on these, i.e., [oqs-provider]
    No

Generative AI
This contribution is not made with the help of a generative AI.

Signed-off-by: P Charishma Kumari <charishma1407@gmail.com>
@charishma1407
charishma1407 force-pushed the charishma_requirements_txt branch from d0559e8 to 395c711 Compare July 28, 2026 07:07
@dstebila

Copy link
Copy Markdown
Member

Hi @charishma1407, thanks for looking at this. As far as I can tell, on Ubuntu the preferred way to install packages is via apt, rather than pip3. Is there a reason to do it the way you've proposed?

@charishma1407

charishma1407 commented Jul 29, 2026

Copy link
Copy Markdown
Author

You're right — apt is the preferred and safer way to install packages on Ubuntu as it avoids conflicts with system-managed Python. I have reverted the Ubuntu install step back to use apt and keep requirements.txt only for macOS and other platforms where pip3 is the standard approach.
I thought of making it to generic so I made pip3 for both macOS and ubuntu.

@xuganyu96

Copy link
Copy Markdown
Contributor

Hi @charishma1407, thanks for looking at this. As far as I can tell, on Ubuntu the preferred way to install packages is via apt, rather than pip3. Is there a reason to do it the way you've proposed?

With pip we can pin exact version and verify sha-256 checksum. I would actually argue against installing pytest (and its plugins) and other script dependencies via system package manager precisely because apt versions might drift way from pip versions, which then makes CI image dependencies drift from local development setup. Especially for local setup, a virtual environment (i.e. venv, virtualenv, conda) should be the strongly recommended default.

Comment thread requirements.txt
Signed-off-by: P Charishma Kumari <charishma1407@gmail.com>
@charishma1407
charishma1407 force-pushed the charishma_requirements_txt branch from afe1c30 to 8f56654 Compare August 5, 2026 06:38
@charishma1407
charishma1407 requested a review from xuganyu96 August 5, 2026 06:38
@coveralls

Copy link
Copy Markdown

Coverage Status

coverage: 81.416% (-3.5%) from 84.927% — charishma1407:charishma_requirements_txt into open-quantum-safe:main

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.

4 participants