Merge pull request #4 from bleu/jefferson/cow-523-create-baseline-solver-on-python-template

Add Python Baseline Solver & Multi-Engine Architecture

Author: jeffersonBastos

.dockerignore

@@ -13,21 +13,21 @@ jobs:
       packages: write
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
-      - uses: docker/login-action@v1
+      - uses: docker/login-action@v3
         with:
           registry: ghcr.io
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
       - id: meta
-        uses: docker/metadata-action@v3
+        uses: docker/metadata-action@v5
         with:
           images: ghcr.io/${{ github.repository }}
           labels: |
             org.opencontainers.image.licenses=MIT OR Apache-2.0
-      - uses: docker/build-push-action@v2
+      - uses: docker/build-push-action@v5
         with:
           context: .
           file: Dockerfile

.env.sample

@@ -2,28 +2,35 @@ name: pull request
 on:
   pull_request:
   push:
-    branches: [ main ]
+    branches: [main]
 jobs:
   python:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - name: Setup Python 3.10
-        uses: actions/setup-python@v2
+      - uses: actions/checkout@v4
+      - name: Setup Python 3.11
+        id: setup-python
+        uses: actions/setup-python@v4
         with:
-          python-version: '3.10'
-      - name: Install Requirements
-        run:
-          pip install -r requirements.txt
+          python-version: "3.11"
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+        with:
+          version: latest
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+      - name: Cache dependencies
+        uses: actions/cache@v3
+        with:
+          path: .venv
+          key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
+      - name: Install dependencies
+        run: poetry install --no-interaction
       - name: Lint
-        run:
-          pylint src/
+        run: poetry run pylint src/
       - name: Format
-        run:
-          black --check ./
+        run: poetry run black --check ./
       - name: Type Check
-        run:
-          mypy src --strict
+        run: poetry run mypy src --strict
       - name: Unit Tests
-        run:
-           python -m pytest tests/unit
+        run: poetry run python -m pytest src/tests/ -v

.github/workflows/deploy.yaml

@@ -1,3 +1,6 @@
+poetry.lock
+.venv/
+
 *.pyc
 */__pycache__
 venv/

.github/workflows/pull-request.yaml

@@ -0,0 +1,2 @@
+python 3.11.9
+poetry 2.2.1

.gitignore

@@ -1,15 +1,52 @@
-FROM python:3.10-alpine
+# Multi-stage build for Poetry-based Python application
+FROM python:3.11-slim as builder
 
-RUN apk add --update gcc libc-dev linux-headers
+# Install Poetry
+RUN pip install poetry==1.8.4
 
+# Set Poetry configuration
+ENV POETRY_NO_INTERACTION=1 \
+    POETRY_VENV_IN_PROJECT=1 \
+    POETRY_CACHE_DIR=/tmp/poetry_cache
+
+# Set work directory
 WORKDIR /app
 
-# First copy over the requirements.txt and install dependencies, this makes
-# building subsequent images easier.
-COPY requirements.txt .
-RUN pip install -r requirements.txt
+# Copy Poetry files
+COPY pyproject.toml poetry.lock ./
+
+# Install dependencies
+RUN poetry install --only=main --no-root && rm -rf $POETRY_CACHE_DIR
+
+# Production stage
+FROM python:3.11-slim
+
+# Create non-root user
+RUN groupadd -r appuser && useradd -r -g appuser appuser
+
+# Set work directory
+WORKDIR /app
+
+# Copy virtual environment from builder
+COPY --from=builder /app/.venv /app/.venv
+
+# Copy application code
+COPY src/ ./src/
+COPY data/ ./data/
+
+# Make sure we use the virtual environment
+ENV PATH="/app/.venv/bin:$PATH"
+
+# Change ownership to non-root user
+RUN chown -R appuser:appuser /app
+USER appuser
+
+# Expose port
+EXPOSE 8080
 
-# Copy full source (see .dockerignore)
-COPY . .
+# Health check
+HEALTHCHECK --interval=30s --timeout=30s --start-period=5s --retries=3 \
+  CMD curl -f http://localhost:8080/healthz || exit 1
 
-CMD [ "python3", "-m" , "src._server"]
+# Run the application
+CMD ["python", "-m", "src.infra.cli", "run", "--host", "0.0.0.0", "--port", "8080"]

.tool-versions

@@ -0,0 +1,75 @@
+# CoW Protocol Solver Template - Makefile
+# Poetry-based commands for development and testing
+
+.PHONY: help run format test clean install
+
+# Default target
+help:
+	@echo "CoW Protocol Solver Template - Available Commands:"
+	@echo ""
+	@echo "  make run      - Start the solver server"
+	@echo "  make format   - Format code with black"
+	@echo "  make test     - Run all tests"
+	@echo "  make install  - Install dependencies with Poetry"
+	@echo "  make clean    - Clean up temporary files"
+	@echo "  make help     - Show this help message"
+	@echo ""
+	@echo "Examples:"
+	@echo "  make run      # Start server on http://localhost:8080"
+	@echo "  make format   # Format all Python code"
+	@echo "  make test     # Run test suite"
+
+# Start the solver server
+run:
+	@echo "🚀 Starting CoW Protocol Solver..."
+	@echo "Server will be available at: http://localhost:8080"
+	@echo "Press Ctrl+C to stop"
+	@echo ""
+	poetry run python -m src.infra.cli run
+
+# Format code with black
+format:
+	@echo "🎨 Formatting code with black..."
+	poetry run black src/ --line-length 88
+	@echo "✅ Code formatting complete!"
+
+# Run tests
+test:
+	@echo "🧪 Running test suite..."
+	poetry run pytest src/tests/ -v
+	@echo "✅ Tests complete!"
+
+# Install dependencies
+install:
+	@echo "📦 Installing dependencies with Poetry..."
+	poetry install
+	@echo "✅ Installation complete!"
+	@echo "Dependencies are managed by Poetry"
+
+# Clean up temporary files
+clean:
+	@echo "🧹 Cleaning up temporary files..."
+	find . -type f -name "*.pyc" -delete
+	find . -type d -name "__pycache__" -delete
+	find . -type d -name "*.egg-info" -exec rm -rf {} +
+	rm -rf .pytest_cache/
+	rm -rf build/
+	rm -rf dist/
+	@echo "✅ Cleanup complete!"
+
+# Poetry-specific commands
+poetry-install:
+	@echo "📦 Installing dependencies with Poetry..."
+	poetry install
+
+poetry-update:
+	@echo "🔄 Updating dependencies..."
+	poetry update
+
+poetry-check:
+	@echo "🔍 Checking dependencies..."
+	poetry check
+
+poetry-export:
+	@echo "📤 Exporting requirements.txt for compatibility..."
+	poetry export -f requirements.txt --output requirements.txt --without-hashes