From cc08343d37c5c52d9186670c958b42e09cec6702 Mon Sep 17 00:00:00 2001 From: Saquib Saifee Date: Fri, 27 Feb 2026 02:09:08 -0500 Subject: [PATCH] docs(packaging): switch install docs to pyproject workflows --- CONTRIBUTING.md | 8 ++++---- README.md | 2 +- requirements.txt | 26 -------------------------- 3 files changed, 5 insertions(+), 31 deletions(-) delete mode 100644 requirements.txt diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b8ca401..c47b927 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,7 +18,7 @@ Thank you for your interest in contributing to the OWASP AIBOM Generator! This p docker run -p 7860:7860 aibom # Or local Python setup - pip install -r requirements.txt + pip install .[dev] ``` ## Development Workflow @@ -131,7 +131,7 @@ aibom-generator/ │ ├── schemas/ # JSON schemas (CycloneDX, SPDX) │ └── templates/ # HTML templates ├── tests/ # Unit and integration tests -└── requirements.txt +└── pyproject.toml ``` ### Key Concepts @@ -145,7 +145,7 @@ aibom-generator/ ```bash # Install test dependencies -pip install -r requirements.txt +pip install .[dev] # Run all tests pytest @@ -169,7 +169,7 @@ docker run -p 7860:7860 aibom ### Local Development ```bash -pip install -r requirements.txt +pip install .[dev] # Run API server python -m uvicorn src.main:app --reload --port 7860 diff --git a/README.md b/README.md index f0cf12e..901c5fe 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ The tool is also listed in the official **[CycloneDX Tool Center](https://cyclon ### 1. Install Dependencies ```bash -pip install -r requirements.txt +pip install . ``` ### 2. Run Web Application diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index bf42baa..0000000 --- a/requirements.txt +++ /dev/null @@ -1,26 +0,0 @@ -huggingface_hub>=0.19.0 -transformers>=4.36.0 -torch>=2.0.0 -fastapi>=0.104.0 -uvicorn>=0.24.0 -pydantic>=2.4.0 -requests>=2.31.0 -python-dotenv>=1.0.0 -PyYAML>=6.0.1 -flask>=2.3.0 -gunicorn>=21.2.0 -cyclonedx-python-lib>=4.0.0 -python-multipart -jinja2>=3.0.0 -datasets>=2.0.0 -beautifulsoup4>=4.11.0 -nltk>=3.8.0 -python-dateutil>=2.8.0 -jsonschema>=4.17.0 -sentencepiece>=0.1.99 -packageurl-python>=0.11.1 - -# Test dependencies -pytest>=7.0.0 -pytest-mock>=3.10.0 -pytest-cov>=4.0.0 \ No newline at end of file