mongo-replication 0.1.1__tar.gz

mongo_replication-0.1.1/.env.example

@@ -0,0 +1,145 @@
+# MongoDB Replication Tool - Environment Variables
+# =================================================
+# This file contains example environment variable configurations
+# for the job-based replication architecture.
+
+# ------------------------------------------------------------
+# Example 1: Single Production Job
+# ------------------------------------------------------------
+# Use case: Replicate from production to analytics database
+
+MONGOREP_PROD_ENABLED=true
+MONGOREP_PROD_SOURCE_URI=mongodb://localhost:27017/prod_db
+MONGOREP_PROD_DESTINATION_URI=mongodb://localhost:27017/analytics_db
+MONGOREP_PROD_CONFIG_PATH=config/prod_config.yaml
+
+# Usage:
+#   rep scan prod
+#   rep run prod
+
+
+# ------------------------------------------------------------
+# Example 2: Multiple Jobs (Different Destinations)
+# ------------------------------------------------------------
+# Use case: Replicate same source to multiple destinations
+
+# Job 1: Production to Analytics
+MONGOREP_PROD_TO_ANALYTICS_ENABLED=true
+MONGOREP_PROD_TO_ANALYTICS_SOURCE_URI=mongodb://prod-host:27017/prod_db
+MONGOREP_PROD_TO_ANALYTICS_DESTINATION_URI=mongodb://analytics-host:27017/analytics_db
+MONGOREP_PROD_TO_ANALYTICS_CONFIG_PATH=config/prod_to_analytics.yaml
+
+# Job 2: Production to Backup
+MONGOREP_PROD_TO_BACKUP_ENABLED=true
+MONGOREP_PROD_TO_BACKUP_SOURCE_URI=mongodb://prod-host:27017/prod_db
+MONGOREP_PROD_TO_BACKUP_DESTINATION_URI=mongodb://backup-host:27017/backup_db
+MONGOREP_PROD_TO_BACKUP_CONFIG_PATH=config/prod_to_backup.yaml
+
+# Usage:
+#   rep scan prod_to_analytics
+#   rep run prod_to_analytics
+#   rep scan prod_to_backup
+#   rep run prod_to_backup
+
+
+# ------------------------------------------------------------
+# Example 3: Staging to Development
+# ------------------------------------------------------------
+# Use case: Replicate staging data to development environment
+
+MONGOREP_STAGING_TO_DEV_ENABLED=true
+MONGOREP_STAGING_TO_DEV_SOURCE_URI=mongodb://staging-host:27017/staging_db
+MONGOREP_STAGING_TO_DEV_DESTINATION_URI=mongodb://localhost:27017/dev_db
+MONGOREP_STAGING_TO_DEV_CONFIG_PATH=config/staging_to_dev.yaml
+
+
+# ------------------------------------------------------------
+# Example 4: Using MongoDB Atlas
+# ------------------------------------------------------------
+# Use case: Replicate from Atlas cluster to local database
+
+MONGOREP_ATLAS_TO_LOCAL_ENABLED=true
+MONGOREP_ATLAS_TO_LOCAL_SOURCE_URI=mongodb+srv://username:password@cluster0.example.mongodb.net/mydb?retryWrites=true&w=majority
+MONGOREP_ATLAS_TO_LOCAL_DESTINATION_URI=mongodb://localhost:27017/local_db
+MONGOREP_ATLAS_TO_LOCAL_CONFIG_PATH=config/atlas_to_local.yaml
+
+
+# ------------------------------------------------------------
+# Example 5: With Authentication
+# ------------------------------------------------------------
+# Use case: Connect to databases requiring authentication
+
+MONGOREP_SECURE_JOB_ENABLED=true
+MONGOREP_SECURE_JOB_SOURCE_URI=mongodb://admin:SecurePass123@prod-host:27017/prod_db?authSource=admin
+MONGOREP_SECURE_JOB_DESTINATION_URI=mongodb://admin:SecurePass456@analytics-host:27017/analytics_db?authSource=admin
+MONGOREP_SECURE_JOB_CONFIG_PATH=config/secure_job.yaml
+
+
+# ------------------------------------------------------------
+# Environment Variable Pattern Reference
+# ------------------------------------------------------------
+#
+# For each job, set these 4 environment variables:
+#
+# MONGOREP_<JOB_ID>_ENABLED=true|false
+#   - Enable or disable this replication job
+#   - Example: MONGOREP_PROD_ENABLED=true
+#
+# MONGOREP_<JOB_ID>_SOURCE_URI=<mongodb-uri>
+#   - MongoDB connection URI for the source database
+#   - Example: MONGOREP_PROD_SOURCE_URI=mongodb://localhost:27017/source_db
+#
+# MONGOREP_<JOB_ID>_DESTINATION_URI=<mongodb-uri>
+#   - MongoDB connection URI for the destination database
+#   - Example: MONGOREP_PROD_DESTINATION_URI=mongodb://localhost:27017/dest_db
+#
+# MONGOREP_<JOB_ID>_CONFIG_PATH=<path-to-yaml>
+#   - Path to the YAML configuration file
+#   - Required for 'rep run' command
+#   - Generated by 'rep scan' if not provided
+#   - Example: MONGOREP_PROD_CONFIG_PATH=config/prod_config.yaml
+#
+# ------------------------------------------------------------
+# Job ID Naming Rules
+# ------------------------------------------------------------
+#
+# - Use uppercase letters, numbers, and underscores
+# - Should be descriptive and unique
+# - Examples: PROD, STAGING, PROD_TO_ANALYTICS, DAILY_BACKUP
+# - Internally normalized to lowercase (PROD → prod)
+#
+# ------------------------------------------------------------
+# MongoDB URI Format
+# ------------------------------------------------------------
+#
+# Standard format:
+#   mongodb://[username:password@]host[:port]/database[?options]
+#
+# Atlas format:
+#   mongodb+srv://username:password@cluster.mongodb.net/database[?options]
+#
+# Common options:
+#   - authSource=admin (authentication database)
+#   - retryWrites=true (retry failed writes)
+#   - w=majority (write concern)
+#   - ssl=true (enable SSL/TLS)
+#
+# Examples:
+#   - Local: mongodb://localhost:27017/mydb
+#   - Auth: mongodb://user:pass@host:27017/mydb?authSource=admin
+#   - Atlas: mongodb+srv://user:pass@cluster.mongodb.net/mydb
+#
+# ------------------------------------------------------------
+# Security Best Practices
+# ------------------------------------------------------------
+#
+# 1. Never commit .env files with real credentials to git
+# 2. Use .env.example for documentation
+# 3. Add .env to .gitignore
+# 4. Use environment-specific files (.env.dev, .env.prod)
+# 5. Rotate credentials regularly
+# 6. Use read-only credentials for source databases
+# 7. Use restricted credentials for destination databases
+# 8. Consider using secret management tools for production
+#
+# ------------------------------------------------------------

mongo_replication-0.1.1/.github/workflows/ci.yaml

@@ -0,0 +1,53 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  ci:
+    name: Run CI
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --all-extras --dev
+
+      - name: Run lint
+        run: uv run task lint
+
+      - name: Run build
+        run: uv run task build
+
+      - name: Run tests
+        run: uv run task test
+
+      - name: Upload coverage reports
+        if: matrix.python-version == '3.10'
+        uses: codecov/codecov-action@v4
+        with:
+          file: ./coverage.xml
+          flags: unittests
+          name: codecov-umbrella
+          fail_ci_if_error: false

mongo_replication-0.1.1/.github/workflows/release.yaml

@@ -0,0 +1,61 @@
+name: Release
+
+on:
+  workflow_run:
+    workflows: ["CI"]
+    branches:
+      - main
+    types:
+      - completed
+
+jobs:
+  release:
+    name: Release to PyPI
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    concurrency: release
+    permissions:
+      id-token: write
+      contents: write
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install dependencies
+        run: |
+          uv sync --all-extras --dev
+          uv pip install python-semantic-release
+
+      - name: Python Semantic Release
+        id: release
+        uses: python-semantic-release/python-semantic-release@v9.12.0
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Publish to PyPI
+        if: steps.release.outputs.released == 'true'
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}
+
+      - name: Publish GitHub Release
+        if: steps.release.outputs.released == 'true'
+        uses: python-semantic-release/publish-action@v9.12.0
+        with:
+          github_token: ${{ secrets.RELEASE_TOKEN }}
+          tag: ${{ steps.release.outputs.tag }}

mongo_replication-0.1.1/.gitignore

@@ -0,0 +1,58 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Virtual environments
+venv/
+env/
+ENV/
+.venv
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.DS_Store
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+
+# Environment variables
+.env
+.env.local
+
+# Configuration (may contain sensitive data)
+config/*.yaml
+!config/example_*.yaml
+
+# Logs
+*.log
+
+# Distribution / packaging
+*.whl
+
+# uv
+.python-version

mongo_replication-0.1.1/.pre-commit-config.yaml

@@ -0,0 +1,44 @@
+default_language_version:
+  python: python3.10
+
+default_stages: [ pre-commit, pre-push ]
+
+repos:
+  # Common Hooks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: check-merge-conflict
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-added-large-files
+        args: [ '--maxkb=25000' ]
+      - id: check-case-conflict
+      - id: check-docstring-first
+      - id: check-ast
+      - id: check-yaml
+      - id: check-json
+
+  # Lock uv
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    # uv version.
+    rev: 0.11.3
+    hooks:
+      - id: uv-lock
+
+  # Linter (ruff)
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.15.9
+    hooks:
+      - id: ruff-check
+        args: [ --fix ]
+        name: Lint python code
+        language_version: python3.10
+
+  # Formatter (ruff)
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.15.9
+    hooks:
+      - id: ruff-format
+        name: Format python code
+        language_version: python3.10