Add justfile and modernize project tooling

The changes modernize the project setup by: - Adding a justfile for task
automation - Switching to uv for dependency management - Adding proper project
dependencies - Improving documentation with quick start guide - Adding new
development commands

Author: edoardob90

README.md

@@ -8,39 +8,93 @@ This repository contains the code for the Marketplace service demo to follow alo
 
 ### How to run this service?
 
-1. Create a python virtual environment and activate it:
+#### Prerequisites
+
+1. Install [uv](https://docs.astral.sh/uv/) for Python package management
+2. Install [just](https://github.com/casey/just) for task running:
+   - macOS: `brew install just`
+   - Linux: `cargo install just` or download from releases
+   - Windows: `scoop install just` or `cargo install just`
+
+#### Quick Start
+
+1. Install dependencies using uv:
 
     ```sh
-    python3.12 -m venv ./venv
-    source ./venv/bin/activate
+    just install
     ```
 
-2. Install your service dependencies:
+2. Run the service:
 
     ```sh
-    python3.12 -m pip install -r requirements.txt
+    just run
     ```
 
-3. Run the service:
+3. In a new terminal window, test the API:
 
     ```sh
-    ./run.sh run
+    # Get all customers
+    just customers
+    
+    # Get orders for customer 1
+    just orders
+    
+    # Get orders for a specific customer
+    just orders 2
+    
+    # Get order total
+    just order-total 1
+    
+    # Create a new order
+    just new-order
+    
+    # Test all endpoints at once
+    just test-all
+    ```
+
+#### Available Commands
+
+Run `just` or `just --list` to see all available commands:
+
+- `just run` - Start the marketplace server
+- `just customers` - Get all customers
+- `just orders [customer_id]` - Get customer orders (default customer_id=1)
+- `just order-total [order_id]` - Get order total cost (default order_id=1)
+- `just orders-between [before] [after]` - Get orders between dates
+- `just new-order` - Create a new order with default values
+- `just new-order-custom <customer_id> <items_json>` - Create a custom order
+- `just test-all` - Test all API endpoints
+- `just endpoints` - Show available API endpoints
+- `just install` - Install dependencies
+- `just lint` - Run code linting
+- `just format` - Format code
+- `just clean` - Clean up Python cache files
+
+#### Legacy Method (still works)
+
+If you prefer the old approach:
+
+1. Create a python virtual environment and activate it:
+
+    ```sh
+    python3.12 -m venv ./venv
+    source ./venv/bin/activate
     ```
 
-    which is equivalent to
+2. Install your service dependencies:
 
     ```sh
-    python3.12 marketsvc/server.py
+    python3.12 -m pip install -r requirements.txt
     ```
 
-4. In a new terminal window, run the `curl` commands:
+3. Run the service:
 
     ```sh
-    ./run.sh customers
+    ./run.sh run
     ```
 
-    which is equivalent to
+4. Test the API:
 
     ```sh
-    curl http://localhost:9090/api/customers
+    ./run.sh customers
     ```

justfile

@@ -0,0 +1,85 @@
+# Marketplace SQLAlchemy Workshop - Task Runner
+# Use 'just --list' to see all available commands
+
+# Default recipe to display help
+default:
+    @just --list
+
+# Run the marketplace server
+run:
+    uv run python marketsvc/server.py
+
+# Get all customers
+customers:
+    curl http://localhost:9090/api/customers
+
+# Get customer orders (specify customer_id, default=1)
+orders customer_id="1":
+    curl http://localhost:9090/api/orders/{{customer_id}}
+
+# Get order total cost (specify order_id, default=1)
+order-total order_id="1":
+    curl http://localhost:9090/api/order_total/{{order_id}}
+
+# Get orders between dates
+orders-between before="2024-03-22" after="2024-03-14":
+    curl "http://localhost:9090/api/orders_between_dates/{{before}}/{{after}}"
+
+# Create a new order
+new-order:
+    curl -H "Content-Type: application/json" -d '{"customer_id":1,"items":[{"id":2,"quantity":4},{"id":3,"quantity":6}]}' http://localhost:9090/api/add_new_order
+
+# Create a custom new order (specify customer_id and items as JSON string)
+new-order-custom customer_id items:
+    curl -H "Content-Type: application/json" -d '{"customer_id":{{customer_id}},"items":{{items}}}' http://localhost:9090/api/add_new_order
+
+# Install dependencies using uv
+install:
+    uv sync
+
+# Install development dependencies
+install-dev:
+    uv sync --dev
+
+# Run linting with ruff
+lint:
+    uv run ruff check .
+
+# Format code with ruff
+format:
+    uv run ruff format .
+
+# Run both linting and formatting
+check: lint format
+
+# Clean up Python cache files
+clean:
+    find . -type f -name "*.pyc" -delete
+    find . -type d -name "__pycache__" -delete
+
+# Show API endpoints (requires server to be running)
+endpoints:
+    @echo "Available API endpoints:"
+    @echo "  GET  http://localhost:9090/"
+    @echo "  GET  http://localhost:9090/api/customers"
+    @echo "  GET  http://localhost:9090/api/orders/{customer_id}"
+    @echo "  GET  http://localhost:9090/api/order_total/{order_id}"
+    @echo "  GET  http://localhost:9090/api/orders_between_dates/{before}/{after}"
+    @echo "  POST http://localhost:9090/api/add_new_order"
+
+# Test all endpoints (requires server to be running in another terminal)
+test-all:
+    @echo "Testing all endpoints..."
+    @echo "\n1. Testing root endpoint:"
+    -curl -s http://localhost:9090/
+    @echo "\n\n2. Testing customers:"
+    -curl -s http://localhost:9090/api/customers
+    @echo "\n\n3. Testing customer orders:"
+    -curl -s http://localhost:9090/api/orders/1
+    @echo "\n\n4. Testing order total:"
+    -curl -s http://localhost:9090/api/order_total/1
+    @echo "\n\n5. Testing orders between dates:"
+    -curl -s "http://localhost:9090/api/orders_between_dates/2024-03-22/2024-03-14"
+    @echo "\n\n6. Testing new order creation:"
+    -curl -s -H "Content-Type: application/json" -d '{"customer_id":1,"items":[{"id":2,"quantity":4},{"id":3,"quantity":6}]}' http://localhost:9090/api/add_new_order
+    @echo "\n\nAll tests completed!"

pyproject.toml

@@ -12,10 +12,22 @@ authors = [
   { name = "Aya Elsayed", email = "ayah.ehab11@gmail.com" },
   { name = "Rhythm Patel", email = "rhythmkumar18083@iiitd.ac.in" },
 ]
-dependencies = []
+dependencies = [
+  "fastapi",
+  "uvicorn[standard]",
+  "sqlalchemy",
+  "aiosqlite",
+  "greenlet",
+]
 
 [project.optional-dependencies]
-dev = ["ruff"]
+dev = [
+  "ruff",
+]
 
 [tool.setuptools.packages.find]
-where = ["marketsvc"]
+where = ["."]
+include = ["marketsvc*"]
+
+[tool.uv]
+dev-dependencies = []