ClickMigrate 1.0.0__tar.gz → 1.0.3__tar.gz

{clickmigrate-1.0.0/src/ClickMigrate.egg-info → clickmigrate-1.0.3}/PKG-INFO

@@ -1,9 +1,25 @@
 Metadata-Version: 2.4
 Name: ClickMigrate
-Version: 1.0.0
+Version: 1.0.3
 Summary: A modern, simple database migration framework for ClickHouse.
 Author-email: Ivo Theis <ivo.theis@queueforge.dev>
 License: MIT
+Project-URL: Homepage, https://queueforge.dev
+Project-URL: Repository, https://github.com/queueforge/ClickMigrate
+Project-URL: Issues, https://github.com/queueforge/ClickMigrate/issues
+Project-URL: Releases, https://github.com/queueforge/ClickMigrate/releases
+Project-URL: Changelog, https://github.com/queueforge/ClickMigrate/blob/main/CHANGELOG.md
+Keywords: clickhouse,database,migration,migrations,sql,cli
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Libraries
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -16,6 +32,7 @@ Requires-Dist: pytest>=7.0.0; extra == "dev"
 Requires-Dist: black>=23.0.0; extra == "dev"
 Requires-Dist: ruff>=0.1.0; extra == "dev"
 Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: types-PyYAML>=6.0.12.20260518; extra == "dev"
 Requires-Dist: build>=1.0.0; extra == "dev"
 Requires-Dist: twine>=4.0.0; extra == "dev"
 Dynamic: license-file
@@ -26,6 +43,10 @@ A modern, simple, and reliable database migration framework for ClickHouse, insp
 
 ClickMigrate is designed to be lightweight and easy to understand. It avoids over-engineered abstractions, offering a straightforward CLI and a clean Python API for managing your ClickHouse schema evolutions.
 
+## About
+
+**ClickMigrate** is an open-source project developed and maintained by **QueueForge**. It is designed to provide a modern, simple, and reliable migration framework for ClickHouse databases. Learn more about QueueForge at [**https://queueforge.dev**](https://queueforge.dev?utm_source=README&utm_campaign=ClickMigrate).
+
 ---
 
 ## Features

{clickmigrate-1.0.0 → clickmigrate-1.0.3}/README.md

@@ -4,6 +4,10 @@ A modern, simple, and reliable database migration framework for ClickHouse, insp
 
 ClickMigrate is designed to be lightweight and easy to understand. It avoids over-engineered abstractions, offering a straightforward CLI and a clean Python API for managing your ClickHouse schema evolutions.
 
+## About
+
+**ClickMigrate** is an open-source project developed and maintained by **QueueForge**. It is designed to provide a modern, simple, and reliable migration framework for ClickHouse databases. Learn more about QueueForge at [**https://queueforge.dev**](https://queueforge.dev?utm_source=README&utm_campaign=ClickMigrate).
+
 ---
 
 ## Features

clickmigrate-1.0.3/pyproject.toml

@@ -0,0 +1,80 @@
+[build-system]
+requires = ["setuptools>=61.0.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ClickMigrate"
+version = "1.0.3"
+description = "A modern, simple database migration framework for ClickHouse."
+readme = "README.md"
+requires-python = ">=3.11"
+license = { text = "MIT" }
+
+authors = [
+    { name = "Ivo Theis", email = "ivo.theis@queueforge.dev" }
+]
+
+dependencies = [
+    "clickhouse-connect>=0.6.8",
+    "typer>=0.9.0",
+    "rich>=13.0.0",
+    "pyyaml>=6.0.1",
+]
+
+keywords = [
+    "clickhouse",
+    "database",
+    "migration",
+    "migrations",
+    "sql",
+    "cli",
+]
+
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Database",
+    "Topic :: Software Development :: Libraries",
+]
+
+[project.urls]
+Homepage = "https://queueforge.dev"
+Repository = "https://github.com/queueforge/ClickMigrate"
+Issues = "https://github.com/queueforge/ClickMigrate/issues"
+Releases = "https://github.com/queueforge/ClickMigrate/releases"
+Changelog = "https://github.com/queueforge/ClickMigrate/blob/main/CHANGELOG.md"
+
+[project.scripts]
+clickmigrate = "clickmigrate.cli:app"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0.0",
+    "black>=23.0.0",
+    "ruff>=0.1.0",
+    "mypy>=1.0.0",
+    "types-PyYAML>=6.0.12.20260518",
+    "build>=1.0.0",
+    "twine>=4.0.0"
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.black]
+line-length = 88
+target-version = ["py311"]
+
+[tool.ruff]
+line-length = 88
+target-version = "py311"
+
+[tool.mypy]
+python_version = "3.11"
+strict = true

{clickmigrate-1.0.0 → clickmigrate-1.0.3/src/ClickMigrate.egg-info}/PKG-INFO

@@ -1,9 +1,25 @@
 Metadata-Version: 2.4
 Name: ClickMigrate
-Version: 1.0.0
+Version: 1.0.3
 Summary: A modern, simple database migration framework for ClickHouse.
 Author-email: Ivo Theis <ivo.theis@queueforge.dev>
 License: MIT
+Project-URL: Homepage, https://queueforge.dev
+Project-URL: Repository, https://github.com/queueforge/ClickMigrate
+Project-URL: Issues, https://github.com/queueforge/ClickMigrate/issues
+Project-URL: Releases, https://github.com/queueforge/ClickMigrate/releases
+Project-URL: Changelog, https://github.com/queueforge/ClickMigrate/blob/main/CHANGELOG.md
+Keywords: clickhouse,database,migration,migrations,sql,cli
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Libraries
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -16,6 +32,7 @@ Requires-Dist: pytest>=7.0.0; extra == "dev"
 Requires-Dist: black>=23.0.0; extra == "dev"
 Requires-Dist: ruff>=0.1.0; extra == "dev"
 Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: types-PyYAML>=6.0.12.20260518; extra == "dev"
 Requires-Dist: build>=1.0.0; extra == "dev"
 Requires-Dist: twine>=4.0.0; extra == "dev"
 Dynamic: license-file
@@ -26,6 +43,10 @@ A modern, simple, and reliable database migration framework for ClickHouse, insp
 
 ClickMigrate is designed to be lightweight and easy to understand. It avoids over-engineered abstractions, offering a straightforward CLI and a clean Python API for managing your ClickHouse schema evolutions.
 
+## About
+
+**ClickMigrate** is an open-source project developed and maintained by **QueueForge**. It is designed to provide a modern, simple, and reliable migration framework for ClickHouse databases. Learn more about QueueForge at [**https://queueforge.dev**](https://queueforge.dev?utm_source=README&utm_campaign=ClickMigrate).
+
 ---
 
 ## Features

{clickmigrate-1.0.0 → clickmigrate-1.0.3}/src/ClickMigrate.egg-info/requires.txt

@@ -8,5 +8,6 @@ pytest>=7.0.0
 black>=23.0.0
 ruff>=0.1.0
 mypy>=1.0.0
+types-PyYAML>=6.0.12.20260518
 build>=1.0.0
 twine>=4.0.0

{clickmigrate-1.0.0 → clickmigrate-1.0.3}/src/clickmigrate/__init__.py

@@ -3,4 +3,4 @@
 from clickmigrate.manager import MigrationManager
 from clickmigrate.config import Config
 
-__all__ = ["MigrationManager", "Config"]
+__all__ = ["MigrationManager", "Config"]

{clickmigrate-1.0.0 → clickmigrate-1.0.3}/src/clickmigrate/__main__.py

@@ -3,4 +3,4 @@
 from clickmigrate.cli import app
 
 if __name__ == "__main__":
-    app()
+    app()

{clickmigrate-1.0.0 → clickmigrate-1.0.3}/src/clickmigrate/cli.py

@@ -2,7 +2,6 @@
 
 import typer
 from rich.console import Console
-from rich.table import Table
 from clickmigrate.config import load_config
 from clickmigrate.manager import MigrationManager
 from clickmigrate.exceptions import ClickMigrateError
@@ -10,6 +9,7 @@ from clickmigrate.exceptions import ClickMigrateError
 app = typer.Typer(help="ClickMigrate: A modern ClickHouse migration framework.")
 console = Console()
 
+
 def get_manager() -> MigrationManager:
     try:
         config = load_config()
@@ -18,49 +18,64 @@ def get_manager() -> MigrationManager:
         console.print(f"[bold red]Initialization Error:[/bold red] {e}")
         raise typer.Exit(code=1)
 
+
 @app.command()
 def init() -> None:
     """Initialize a new ClickMigrate environment."""
     config = load_config()
     import os
+
     os.makedirs(config.migration_directory, exist_ok=True)
-    console.print(f"[green]Initialized ClickMigrate in ./{config.migration_directory}/[/green]")
+    console.print(
+        f"[green]Initialized ClickMigrate in ./{config.migration_directory}/[/green]"
+    )
+
 
 @app.command()
-def revision(message: str = typer.Option(..., "-m", "--message", help="Migration description")) -> None:
+def revision(
+    message: str = typer.Option(..., "-m", "--message", help="Migration description")
+) -> None:
     """Create a new migration file."""
     manager = get_manager()
     filepath = manager.create_revision(message)
     console.print(f"[green]Created revision:[/green] {filepath}")
 
+
 @app.command()
-def migrate(dry_run: bool = typer.Option(False, "--dry-run", help="Simulate migration without applying")) -> None:
+def migrate(
+    dry_run: bool = typer.Option(
+        False, "--dry-run", help="Simulate migration without applying"
+    )
+) -> None:
     """Apply all pending migrations."""
     console.print("\n[bold]ClickMigrate[/bold]\n")
     manager = get_manager()
-    
+
     try:
         applied_count, pending_count = manager.status()
         if pending_count == 0:
             console.print("No pending migrations.\n")
             return
-            
+
         console.print(f"Applying [yellow]{pending_count}[/yellow] migrations...\n")
-        
+
         if dry_run:
-            console.print("[yellow]DRY RUN: No changes will be made to the database.[/yellow]\n")
-            
+            console.print(
+                "[yellow]DRY RUN: No changes will be made to the database.[/yellow]\n"
+            )
+
         applied, duration = manager.migrate(dry_run=dry_run)
-        
+
         console.print("\n[bold green]SUCCESS[/bold green]\n")
         console.print(f"Applied migrations : {applied}")
         console.print(f"Pending migrations : {pending_count - applied}")
         console.print(f"Execution time     : {duration:.2f} seconds\n")
-        
+
     except ClickMigrateError as e:
         console.print(f"\n[bold red]FAILED[/bold red]\n{e}")
         raise typer.Exit(code=1)
 
+
 @app.command()
 def status() -> None:
     """Show current migration status."""
@@ -69,16 +84,20 @@ def status() -> None:
     console.print(f"Applied migrations : [green]{applied}[/green]")
     console.print(f"Pending migrations : [yellow]{pending}[/yellow]")
 
+
 @app.command()
 def validate() -> None:
     """Validate checksums of applied migrations against local files."""
     manager = get_manager()
     try:
         manager.validate()
-        console.print("[green]All migrations are valid. No checksum mismatches.[/green]")
+        console.print(
+            "[green]All migrations are valid. No checksum mismatches.[/green]"
+        )
     except ClickMigrateError as e:
         console.print(f"[bold red]Validation Failed:[/bold red] {e}")
         raise typer.Exit(code=1)
 
+
 if __name__ == "__main__":
-    app()
+    app()

{clickmigrate-1.0.0 → clickmigrate-1.0.3}/src/clickmigrate/config.py

@@ -6,11 +6,12 @@ import tomllib
 from dataclasses import dataclass
 from typing import Any, Dict
 import yaml
-from clickmigrate.exceptions import ConfigurationError
+
 
 @dataclass
 class Config:
     """Stores the ClickMigrate configuration."""
+
     host: str = "localhost"
     port: int = 8123
     database: str = "default"
@@ -19,6 +20,7 @@ class Config:
     migration_directory: str = "migrations"
     migration_table: str = "clickmigrate_history"
 
+
 def load_config() -> Config:
     """Loads configuration from environment variables or files."""
     config_data: Dict[str, Any] = {}
@@ -49,10 +51,10 @@ def load_config() -> Config:
         "CLICKMIGRATE_DIRECTORY": "migration_directory",
         "CLICKMIGRATE_TABLE": "migration_table",
     }
-    
+
     for env_var, key in env_mapping.items():
         if env_var in os.environ:
             val = os.environ[env_var]
             config_data[key] = int(val) if key == "port" else val
 
-    return Config(**config_data)
+    return Config(**config_data)

{clickmigrate-1.0.0 → clickmigrate-1.0.3}/src/clickmigrate/database.py

@@ -1,18 +1,34 @@
 """Database interaction layer."""
 
+import re
+from typing import Dict
+
 import clickhouse_connect
 from clickhouse_connect.driver.client import Client
-from typing import List, Dict, Any
+
 from clickmigrate.config import Config
 from clickmigrate.exceptions import MigrationError
 
+_IDENTIFIER_RE = re.compile(r"^[A-Za-z_][A-Za-z0-9_]*$")
+
+
 class Database:
     """Handles ClickHouse connections and queries."""
 
     def __init__(self, config: Config) -> None:
         self.config = config
+        self.config.migration_table = self._validate_identifier(
+            self.config.migration_table
+        )
         self.client: Client = self._connect()
 
+    @staticmethod
+    def _validate_identifier(identifier: str) -> str:
+        """Validates SQL identifiers (table names, etc.)."""
+        if not _IDENTIFIER_RE.fullmatch(identifier):
+            raise MigrationError(f"Invalid SQL identifier: {identifier}")
+        return identifier
+
     def _connect(self) -> Client:
         """Establishes a connection to ClickHouse."""
         try:
@@ -24,7 +40,7 @@ class Database:
                 database=self.config.database,
             )
         except Exception as e:
-            raise MigrationError(f"Failed to connect to ClickHouse: {e}")
+            raise MigrationError(f"Failed to connect to ClickHouse: {e}") from e
 
     def ensure_history_table(self) -> None:
         """Creates the migration history table if it doesn't exist."""
@@ -41,26 +57,47 @@ class Database:
 
     def get_applied_migrations(self) -> Dict[str, str]:
         """Retrieves applied migrations and their checksums.
-        
+
         Returns:
             Dict mapping version to checksum.
         """
         self.ensure_history_table()
+
         query = f"SELECT version, checksum FROM {self.config.migration_table}"
         result = self.client.query(query)
+
         return {row[0]: row[1] for row in result.result_rows}
 
-    def apply_migration(self, version: str, name: str, checksum: str, sql: str) -> None:
+    def apply_migration(
+        self,
+        version: str,
+        name: str,
+        checksum: str,
+        sql: str,
+    ) -> None:
         """Executes a migration script and records it in the history table."""
         try:
-            # Execute the actual migration
+            # Execute the migration SQL
             self.client.command(sql)
-            
-            # Record in history
-            record_query = f"""
-            INSERT INTO {self.config.migration_table} (version, name, checksum)
-            VALUES ('{version}', '{name}', '{checksum}')
+
+            # Record migration using parameterized query
+            query = f"""
+            INSERT INTO {self.config.migration_table}
+                (version, name, checksum)
+            VALUES
+                (%(version)s, %(name)s, %(checksum)s)
             """
-            self.client.command(record_query)
+
+            self.client.command(
+                query,
+                parameters={
+                    "version": version,
+                    "name": name,
+                    "checksum": checksum,
+                },
+            )
+
         except Exception as e:
-            raise MigrationError(f"Failed to apply migration {version}_{name}: {e}")
+            raise MigrationError(
+                f"Failed to apply migration {version}_{name}: {e}"
+            ) from e

{clickmigrate-1.0.0 → clickmigrate-1.0.3}/src/clickmigrate/exceptions.py

@@ -1,17 +1,25 @@
 """Custom exceptions for ClickMigrate."""
 
+
 class ClickMigrateError(Exception):
     """Base exception for all ClickMigrate errors."""
+
     pass
 
+
 class ConfigurationError(ClickMigrateError):
     """Raised when configuration is invalid or missing."""
+
     pass
 
+
 class MigrationError(ClickMigrateError):
     """Raised when a migration fails to apply."""
+
     pass
 
+
 class ChecksumError(ClickMigrateError):
     """Raised when an applied migration's checksum differs from the file."""
-    pass
+
+    pass

{clickmigrate-1.0.0 → clickmigrate-1.0.3}/src/clickmigrate/manager.py

@@ -1,23 +1,27 @@
 """Core migration management logic."""
 
 import os
+import re
 import hashlib
 import time
 from typing import List, Tuple
 from dataclasses import dataclass
 from clickmigrate.config import Config
 from clickmigrate.database import Database
-from clickmigrate.exceptions import ChecksumError, ClickMigrateError
+from clickmigrate.exceptions import ChecksumError
+
 
 @dataclass
 class Migration:
     """Represents a single SQL migration."""
+
     version: str
     name: str
     filepath: str
     content: str
     checksum: str
 
+
 class MigrationManager:
     """API for managing ClickHouse migrations."""
 
@@ -31,7 +35,7 @@ class MigrationManager:
 
     def _get_local_migrations(self) -> List[Migration]:
         """Discovers and parses local .sql migration files."""
-        migrations = []
+        migrations: List[Migration] = []
         if not os.path.exists(self.config.migration_directory):
             return migrations
 
@@ -40,16 +44,16 @@ class MigrationManager:
                 parts = filename.replace(".sql", "").split("_", 1)
                 if len(parts) != 2:
                     continue
-                
+
                 version, name = parts
                 filepath = os.path.join(self.config.migration_directory, filename)
-                
+
                 with open(filepath, "r", encoding="utf-8") as f:
                     content = f.read()
-                
+
                 checksum = self._calculate_checksum(content)
                 migrations.append(Migration(version, name, filepath, content, checksum))
-                
+
         return migrations
 
     def validate(self) -> None:
@@ -74,16 +78,16 @@ class MigrationManager:
 
     def migrate(self, dry_run: bool = False) -> Tuple[int, float]:
         """Applies all pending migrations.
-        
+
         Returns:
             Tuple containing (number of migrations applied, execution time in seconds).
         """
         self.validate()
         applied_map = self.db.get_applied_migrations()
         local = self._get_local_migrations()
-        
+
         pending = [m for m in local if m.version not in applied_map]
-        
+
         if dry_run or not pending:
             return len(pending), 0.0
 
@@ -93,24 +97,24 @@ class MigrationManager:
                 version=migration.version,
                 name=migration.name,
                 checksum=migration.checksum,
-                sql=migration.content
+                sql=migration.content,
             )
-            
+
         return len(pending), time.time() - start_time
 
     def create_revision(self, message: str) -> str:
         """Creates a new empty migration file."""
         os.makedirs(self.config.migration_directory, exist_ok=True)
         local = self._get_local_migrations()
-        
+
         next_version = 1 if not local else int(local[-1].version) + 1
         version_str = f"{next_version:03d}"
-        
-        safe_name = message.lower().replace(" ", "_").replace("-", "_")
+
+        safe_name = re.sub(r"[^a-zA-Z0-9_]", "", message.lower()).replace(" ", "_").replace("-", "_")
         filename = f"{version_str}_{safe_name}.sql"
         filepath = os.path.join(self.config.migration_directory, filename)
-        
+
         with open(filepath, "w", encoding="utf-8") as f:
             f.write(f"-- Migration: {message}\n-- Version: {version_str}\n\n")
-            
-        return filepath
+
+        return filepath

clickmigrate-1.0.0/pyproject.toml

@@ -1,46 +0,0 @@
-[build-system]
-requires = ["setuptools>=61.0.0", "wheel"]
-build-backend = "setuptools.build_meta"
-
-[project]
-name = "ClickMigrate"
-version = "1.0.0"
-description = "A modern, simple database migration framework for ClickHouse."
-readme = "README.md"
-requires-python = ">=3.11"
-license = { text = "MIT" }
-authors = [{ name = "Ivo Theis", email = "ivo.theis@queueforge.dev" }]
-dependencies = [
-    "clickhouse-connect>=0.6.8",
-    "typer>=0.9.0",
-    "rich>=13.0.0",
-    "pyyaml>=6.0.1", # Added for YAML config support
-]
-
-[project.scripts]
-clickmigrate = "clickmigrate.cli:app"
-
-[project.optional-dependencies]
-dev = [
-    "pytest>=7.0.0",
-    "black>=23.0.0",
-    "ruff>=0.1.0",
-    "mypy>=1.0.0",
-    "build>=1.0.0",
-    "twine>=4.0.0"
-]
-
-[tool.setuptools.packages.find]
-where = ["src"]
-
-[tool.black]
-line-length = 88
-target-version = ["py311"]
-
-[tool.ruff]
-line-length = 88
-target-version = "py311"
-
-[tool.mypy]
-python_version = "3.11"
-strict = true