Skip to content

Commit

Permalink
convert to poetry
Browse files Browse the repository at this point in the history
  • Loading branch information
EnzoFanAccount committed Feb 22, 2025
1 parent 024bddd commit 564a28d
Show file tree
Hide file tree
Showing 5 changed files with 6,689 additions and 52 deletions.
13 changes: 9 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,15 @@ Enhancement suggestions are tracked as GitHub issues. When creating an enhanceme

1. Set up Python environment:
```bash
python -m venv venv
source venv/bin/activate # or `venv\Scripts\activate` on Windows
# Install Poetry (if not already installed)
pip install poetry

# Install dependencies
cd backend
pip install -r requirements.txt
poetry install --extras "ml compliance" # Install all dependencies for development

# Activate virtual environment
poetry shell
```

2. Install external tools:
Expand All @@ -65,7 +70,7 @@ pip install -r requirements.txt

3. Run tests:
```bash
pytest
poetry run pytest
```

### Frontend Development
Expand Down
24 changes: 21 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@

### Prerequisites
- Python 3.10 only (Due to TensorFlow) (Backend)
- Poetry (Python dependency management)
- Node.js 18+ (Frontend)
- Docker 24+ (Container deployment)
- Syft 1.0+ and Trivy 0.50+ (SBOM generation)
Expand All @@ -76,12 +77,29 @@
git clone https://github.com/EnzoFanAccount/sbombardier.git
cd sbombardier
```
2. Install Python dependencies

2. Install Poetry (if not already installed):
```bash
pip install poetry
```

3. Install Python dependencies:
```bash
cd backend
pip install -r requirements.txt
# Install core dependencies only
poetry install

# Install with ML support
poetry install --extras ml

# Install with compliance features
poetry install --extras compliance

# Install all optional dependencies
poetry install --extras "ml compliance"
```
3. Install external tools:

4. Install external tools:
- [Syft](https://github.com/anchore/syft#installation)
- [Trivy](https://aquasecurity.github.io/trivy/latest/getting-started/installation/)
- [Open Policy Agent](https://www.openpolicyagent.org/docs/latest/#1-download-opa)
Expand Down
Loading

0 comments on commit 564a28d

Please sign in to comment.