Skip to content

Commit

Permalink
Update READMEs, pyproject.toml and Dockerfile
Browse files Browse the repository at this point in the history
  • Loading branch information
Matan-Giladi committed Jan 26, 2025
1 parent 4fd788f commit eff6544
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 7 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@ Deploying PRevent involves three parts, typically completed in 5 minutes to an h
2. Create a GitHub app within your GitHub organization or account.
3. Deploy the application to a server.

Use the latest Python version (3.9.2+ supported).


## Non-Containerized Setup

Expand All @@ -87,7 +89,7 @@ Parts 1 and 2 are handled during the interactive setup process in step 3:
git clone https://github.com/apiiro/prevent.git
cd prevent
```
2. Install dependencies by either:
2. Install dependencies by either poetry (recommended) or pip:
```bash
poetry install

Expand Down
2 changes: 1 addition & 1 deletion docker/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ COPY ../setup /prevent/setup
COPY ../pyproject.toml /prevent/pyproject.toml

# Install project dependencies with Poetry
RUN poetry install --no-interaction --no-dev
RUN poetry install --no-interaction --only main

EXPOSE 8080

Expand Down
8 changes: 4 additions & 4 deletions docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
1. Build the app using the provided `Dockerfile`:

```bash
docker buildx build -t prevent .
docker buildx build -t prevent . -f docker/Dockerfile
```

1. Push the image to your container registry (e.g. GCR):
2. Push the image to your container registry (e.g. GCR):

```bash
PREVENT_PATH=<your.artifact.registry>
Expand All @@ -19,15 +19,15 @@ docker buildx build \
../.
```

1. Run the container:
3. Run the container:

```bash
PREVENT_PATH=<your.artifact.registry>
PREVENT_TAG=1.0
docker run --rm -it $PREVENT_PATH:$PREVENT_TAG
```

1. Access the container:
4. Access the container:

```bash
PREVENT_PATH=<your.artifact.registry>
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,5 @@ semgrep = "1.102.0"
toml = "0.10.2"
werkzeug = "3.1.3"

[tool.poetry.dev-dependencies]
[tool.poetry.group.dev.dependencies]
pytest = "8.3.4"

0 comments on commit eff6544

Please sign in to comment.