Add Python version and update project structure with pyproject.toml

Author: npv2k1

.python-version

@@ -0,0 +1 @@
+3.11

Dockerfile

@@ -1,22 +1,34 @@
-# Stage 1: Build 
-FROM python:3.10.7-slim-buster as builder
+# Use a Python image with uv pre-installed
+FROM ghcr.io/astral-sh/uv:python3.11-bookworm
 
+# Install the project into `/app`
 WORKDIR /app
 
-COPY requirements.txt .
+# Enable bytecode compilation
+ENV UV_COMPILE_BYTECODE=1
 
-# Install build dependencies and libraries
-RUN pip install --no-cache-dir -r requirements.txt
+# Copy from the cache instead of linking since it's a mounted volume
+ENV UV_LINK_MODE=copy
 
+# Install the project's dependencies using the lockfile and settings
+RUN --mount=type=cache,target=/root/.cache/uv \
+  --mount=type=bind,source=uv.lock,target=uv.lock \
+  --mount=type=bind,source=pyproject.toml,target=pyproject.toml \
+  uv sync --frozen --no-install-project --no-dev
 
-# Stage 2: Production
-FROM python:3.10.7-slim-buster as production
+# Then, add the rest of the project source code and install it
+# Installing separately from its dependencies allows optimal layer caching
+ADD . /app
+RUN --mount=type=cache,target=/root/.cache/uv \
+  uv sync --frozen --no-dev
 
-WORKDIR /app
-
-COPY . .
+# Place executables in the environment at the front of the path
+ENV PATH="/app/.venv/bin:$PATH"
 
-# Copy only the compiled result from previous stage
-COPY --from=builder /app .
+# Reset the entrypoint, don't invoke `uv`
+ENTRYPOINT []
 
+# Run the FastAPI application by default
+# Uses `fastapi dev` to enable hot-reloading when the `watch` sync occurs
+# Uses `--host 0.0.0.0` to allow access from outside the container
 CMD ["python", "main.py"]

README.md

@@ -1,41 +1,5 @@
 # docker-volume-backup
 
-example
+## Overview
 
-```yaml
-version: "3.8"
-services:
-  app:
-    image: ubuntu
-    volumes:
-      - app:/app
-      - app1:/app1
-    working_dir: /app
-    stdin_open: true
-    tty: true
-    command: tail -F anything
-
-  backup:
-    build:
-      context: .
-      dockerfile: Dockerfile
-    volumes:
-      - app:/tmp/backups/app:ro
-      - app1:/tmp/backups/app1:ro
-      - ./outputs:/tmp/outputs
-      # save logs to host
-
-    environment:
-      - BACKUP_DIR=/tmp/backups
-      - OUTPUT_DIR=/tmp/outputs
-      - S3_ENDPOINT=
-      - S3_BUCKET=backups
-      - S3_ACCESS_KEY=
-      - S3_SECRET_KEY=
-      - S3_PREFIX=docker
-      - SECOND_INTERVAL=60 // backup interval in seconds
-
-volumes:
-  app:
-  app1:
-```
+`docker-volume-backup` is a project designed to automate the backup of Docker volumes to a specified output directory and optionally upload them to an S3

docker-compose.yml

@@ -1,36 +1,18 @@
-version: '3.8'
+version: "3.8"
 services:
-  app:
-    image: ubuntu
-    volumes:
-      - app:/app
-      - app1:/app1
-    working_dir: /app
-    stdin_open: true
-    tty: true
-    command: tail -F anything
-  
   backup:
-    build: 
+    build:
       context: .
       dockerfile: Dockerfile
     volumes:
-      - app:/tmp/backups/app:ro
-      - app1:/tmp/backups/app1:ro
-      - ./outputs:/tmp/outputs
-      # save logs to host
-      
+      - ./tests/app:/tmp/backups/app:ro
+      - ./tests/output:/tmp/output
     environment:
       - BACKUP_DIR=/tmp/backups
-      - OUTPUT_DIR=/tmp/outputs
-      - S3_ENDPOINT=https://0c5059a262cdf86340651b0d9a085c9e.r2.cloudflarestorage.com
+      - OUTPUT_DIR=/tmp/output
+      - S3_ENDPOINT=
       - S3_BUCKET=backups
-      - S3_ACCESS_KEY=a37a6cd9f857e427818e7aae139689e4
-      - S3_SECRET_KEY=7d8ab79a602a5a236d12e6e3e4bd6339665feea70f187775ff8d1914236e9eab
-      - S3_PREFIX=docker
-      - SECOND_INTERVAL=60    
-    
-    
-volumes:
-  app:
-  app1:
+      - S3_ACCESS_KEY=
+      - S3_SECRET_KEY=
+      - S3_PREFIX=docker-volumes-backup
+      - SECOND_INTERVAL=60

main.py

@@ -1,21 +1,23 @@
 from utils import *
-from botocore.exceptions import NoCredentialsError
 import os
 from dotenv import load_dotenv
 import os
-import time
-import schedule
 import logging
+import schedule
 
 # Load the .env file
-load_dotenv(".env")
+load_dotenv(".env" ,override=True)
 
-# main
-if __name__ == "__main__":
+def main():
     # # Load configuration from .env file
-    mode = os.getenv("MODE")
+    mode = os.getenv("MODE", 'backup') 
     backup_dir = os.getenv("BACKUP_DIR")
     output_dir = os.getenv("OUTPUT_DIR")
+
+    print("backup_drr", backup_dir)
+
+    # logging.info("backup: {backup_dir}")
+
     # Set up logging
     logging.basicConfig(level=logging.INFO,
                         format='%(asctime)s - %(levelname)s - %(message)s',
@@ -33,16 +35,17 @@
 
     if mode == "restore":
         logging.info("Restore mode ")
-        S3_ENDPOINT_URL = os.getenv("S3_ENDPOINT")
-        S3_ACCESS_KEY = os.getenv("S3_ACCESS_KEY")
-        S3_SECRET_KEY = os.getenv("S3_SECRET_KEY")
+        s3 = connect_s3_from_env()
         S3_BUCKET = os.getenv("S3_BUCKET")
-        S3_PREFIX = os.getenv("S3_PREFIX")
         RESTORE_DIR = os.getenv("RESTORE_DIR")
-        if (not S3_ENDPOINT_URL or not S3_ACCESS_KEY or not S3_SECRET_KEY or not S3_BUCKET):
-            logging.error("S3 credentials not found")
-        s3 = connect_s3(S3_ENDPOINT_URL, S3_ACCESS_KEY, S3_SECRET_KEY)
+        if (not RESTORE_DIR):
+             logging.error("Restore dir not found")
+             return
         download_dir_from_s3(
             s3, S3_BUCKET, RESTORE_DIR, output_dir)
         restore_directory(output_dir, backup_dir)
-        logging.info(f"Restore finished at {get_timestamp()}")
+        logging.info(f"Restore finished at {get_time()}")
+
+# main
+if __name__ == "__main__":
+    main()

pyproject.toml

@@ -0,0 +1,12 @@
+[project]
+name = "docker-volume-backup"
+version = "0.1.0"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = [
+    "boto3>=1.35.90",
+    "botocore>=1.35.90",
+    "python-dotenv>=1.0.1",
+    "schedule>=1.2.2",
+]