syncy 0.1.1__tar.gz

syncy-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 hakambing
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

syncy-0.1.1/MANIFEST.in

@@ -0,0 +1,18 @@
+include README.md
+include LICENSE
+include requirements.txt
+include rules.yaml.example
+include validator.yaml.example
+
+prune reports
+prune build
+prune dist
+prune .git
+prune .venv
+prune syncy.egg-info
+prune .pytest_cache
+prune .mypy_cache
+
+global-exclude __pycache__ *.py[cod] .DS_Store
+C:\Users\hakam\AppData\Roaming\Python\Python312\Scripts
+

syncy-0.1.1/PKG-INFO

@@ -0,0 +1,21 @@
+Metadata-Version: 2.4
+Name: syncy
+Version: 0.1.1
+Summary: Database migration validation tool (SQL Server ↔ PostgreSQL)
+Author: 
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+License-File: LICENSE
+Requires-Dist: click>=8.1.0
+Requires-Dist: pyodbc>=5.0.0
+Requires-Dist: psycopg2-binary>=2.9.9
+Requires-Dist: Jinja2>=3.1.2
+Requires-Dist: PyYAML>=6.0.1
+Requires-Dist: sqlparse>=0.4.4
+Dynamic: classifier
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary

syncy-0.1.1/README.md

@@ -0,0 +1,55 @@
+Syncy
+=====
+
+Syncy is a lightweight database migration validation tool for comparing logic and schema objects between SQL Server and PostgreSQL. It focuses on safe, read-only validation and produces HTML + JSON reports.
+
+Features
+- Read-only connectors for MSSQL (pyodbc) and Postgres (psycopg2-binary)
+- Extract views, functions, procedures, triggers metadata/definitions
+- Built-in rule pack (10 cross-engine mismatch checks)
+- Simple behaviour tests on views (sample shape comparison)
+- Timestamped HTML + JSON reports
+
+Quick Start
+0. (Recommended) Create and activate a virtual environment
+   - Windows (PowerShell):
+     python -m venv .venv
+     .\.venv\Scripts\Activate.ps1
+   - macOS/Linux:
+     python3 -m venv .venv
+     source .venv/bin/activate
+
+1. Install dependencies (Python 3.10+):
+   pip install -r requirements.txt
+
+2. Provide connection URLs via flags, YAML, or env:
+   - Flags: --source, --target
+   - YAML: validator.yaml (see example below)
+   - Env: SYNCY_SOURCE_URL, SYNCY_TARGET_URL
+
+3. Seed sample schemas into your own SQL Server/Postgres (optional):
+   python demo/load_samples.py --source "mssql://sa:Your_password123@localhost:1433/master?driver=ODBC+Driver+18+for+SQL+Server&TrustServerCertificate=yes" --target "postgresql://postgres:postgres@localhost:5432/syncy?sslmode=disable"
+
+4. Run validation:
+   syncy validate --source "mssql://sa:Your_password123@localhost:1433/master?driver=ODBC+Driver+18+for+SQL+Server&TrustServerCertificate=yes" \
+                  --target "postgresql://postgres:postgres@localhost:5432/syncy?sslmode=disable" \
+                  --out ./reports/demo/
+
+Config Resolution Order
+1) CLI flags > 2) validator.yaml > 3) environment variables.
+
+validator.yaml example
+source:
+  url: ${SYNCY_SOURCE_URL}
+target:
+  url: ${SYNCY_TARGET_URL}
+include_schemas: [public]
+exclude_schemas: []
+
+Notes
+- All queries run in safe mode. Obvious write operations are blocked.
+- Reports are written to a timestamped folder under the provided --out or ./reports/.
+- For production environments, you may swap psycopg2-binary for psycopg2 in requirements.
+
+License
+MIT

syncy-0.1.1/requirements.txt

@@ -0,0 +1,7 @@
+click>=8.1.0
+pyodbc>=5.0.0
+psycopg2-binary>=2.9.9
+Jinja2>=3.1.2
+PyYAML>=6.0.1
+sqlparse>=0.4.4
+pytest>=7.4.0

syncy-0.1.1/rules.yaml.example

@@ -0,0 +1,53 @@
+---
+# Example rule pack for Syncy. You can customize severities or add/remove rules.
+# Each rule is a simple detector for common cross-engine differences.
+
+- id: R01
+  desc: TOP vs LIMIT
+  severity: major
+  hint: Replace SQL Server TOP with PostgreSQL LIMIT (or FETCH FIRST)
+
+- id: R02
+  desc: ISNULL() vs COALESCE()
+  severity: minor
+  hint: Prefer COALESCE for portability; ISNULL is SQL Server-only
+
+- id: R03
+  desc: IDENTITY vs SEQUENCE
+  severity: major
+  hint: Use GENERATED AS IDENTITY or a SEQUENCE with nextval() default
+
+- id: R04
+  desc: BIT vs BOOLEAN
+  severity: minor
+  hint: Map BIT(1) to BOOLEAN; convert 0/1 to FALSE/TRUE
+
+- id: R05
+  desc: DATETIME vs TIMESTAMP
+  severity: minor
+  hint: Map DATETIME to TIMESTAMP; review precision/timezone
+
+- id: R06
+  desc: NVARCHAR length mismatch
+  severity: minor
+  hint: Align target VARCHAR length to be >= source
+
+- id: R07
+  desc: UUID vs UNIQUEIDENTIFIER
+  severity: major
+  hint: Use PostgreSQL UUID; enable uuid-ossp if generating values
+
+- id: R08
+  desc: Collation differences
+  severity: minor
+  hint: Remove/adjust COLLATE to target equivalent collation
+
+- id: R09
+  desc: Trigger timing mismatch
+  severity: major
+  hint: Convert INSTEAD OF triggers to BEFORE/AFTER with equivalent logic
+
+- id: R10
+  desc: Function name mismatch
+  severity: minor
+  hint: Translate functions (e.g., LEN -> length/char_length)

syncy-0.1.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

syncy-0.1.1/setup.py

@@ -0,0 +1,39 @@
+from pathlib import Path
+from setuptools import setup, find_packages
+
+
+def read_version() -> str:
+    ns = {}
+    with open("syncy/__init__.py", "r", encoding="utf-8") as f:
+        exec(f.read(), ns)
+    return ns.get("__version__", "0.0.0")
+
+
+setup(
+    name="syncy",
+    version=read_version(),
+    description="Database migration validation tool (SQL Server ↔ PostgreSQL)",
+    author="",
+    packages=find_packages(exclude=("tests", "reports")),
+    include_package_data=True,
+    install_requires=[
+        "click>=8.1.0",
+        "pyodbc>=5.0.0",
+        "psycopg2-binary>=2.9.9",
+        "Jinja2>=3.1.2",
+        "PyYAML>=6.0.1",
+        "sqlparse>=0.4.4",
+    ],
+    entry_points={
+        "console_scripts": [
+            "syncy=syncy.cli:cli",
+        ]
+    },
+    python_requires=">=3.10",
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+)
+

syncy-0.1.1/syncy/__init__.py

@@ -0,0 +1,9 @@
+"""Syncy - Database migration validation tool.
+
+Exposes the package version and common constants.
+"""
+
+__all__ = ["__version__"]
+
+__version__ = "0.1.1"
+

syncy-0.1.1/syncy/cli/__init__.py

@@ -0,0 +1,24 @@
+from ..config.runtime import read_rules_yaml_file as _read_rules_yaml_file
+from ..config.runtime import resolve_rule_pack as _resolve_rule_pack
+from .base import cli
+from .utils import (
+    DEFAULT_BEHAVIOUR_LIMIT,
+    DEFAULT_BEHAVIOUR_TIMEOUT_S,
+    _engine_info,
+    _make_output_dir,
+)
+
+# Import submodules so commands register on the group
+from . import gui as _gui  # noqa: F401
+from . import validate as _validate  # noqa: F401
+from . import wizard as _wizard  # noqa: F401
+
+__all__ = [
+    "cli",
+    "_resolve_rule_pack",
+    "_read_rules_yaml_file",
+    "DEFAULT_BEHAVIOUR_LIMIT",
+    "DEFAULT_BEHAVIOUR_TIMEOUT_S",
+    "_engine_info",
+    "_make_output_dir",
+]

syncy-0.1.1/syncy/cli/base.py

@@ -0,0 +1,12 @@
+import click
+
+from .. import __version__
+
+
+@click.group()
+@click.version_option(__version__, prog_name="syncy")
+def cli() -> None:
+    """Syncy CLI - Validate cross-engine DB migrations."""
+
+
+__all__ = ["cli"]

syncy-0.1.1/syncy/cli/gui.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+import click
+
+from .base import cli
+
+
+@cli.command("gui")
+def gui() -> None:
+    """Launch the desktop GUI wrapper."""
+    try:
+        from ..gui.app import main as gui_main
+    except Exception as exc:  # pragma: no cover - GUI-only failure
+        raise click.ClickException(f"GUI not available: {exc}")
+    gui_main()
+
+
+__all__ = ["gui"]

syncy-0.1.1/syncy/cli/utils.py

@@ -0,0 +1,152 @@
+from __future__ import annotations
+
+from datetime import datetime, timezone, timedelta
+from pathlib import Path
+from typing import Dict, Optional
+from urllib.parse import quote_plus
+
+import click
+
+
+DEFAULT_REPORTS_DIR = "reports"
+LOCAL_TZ = timezone(timedelta(hours=8))
+DEFAULT_BEHAVIOUR_LIMIT = 5
+DEFAULT_BEHAVIOUR_TIMEOUT_S = 30
+
+
+def _timestamp() -> str:
+    return datetime.now(LOCAL_TZ).strftime("%Y%m%d_%H%M%S%z")
+
+
+def _prompt_connection_engine(kind: str, default_scheme: str) -> str:
+    choice = click.prompt(
+        f"Choose {kind} engine",
+        type=click.Choice(["mssql", "postgresql"], case_sensitive=False),
+        default=default_scheme,
+    )
+    return choice.lower()
+
+
+def _prompt_optional_params(scheme: str) -> Dict[str, str]:
+    params: Dict[str, str] = {}
+    if scheme == "mssql":
+        driver = click.prompt(
+            "ODBC driver",
+            default="ODBC Driver 18 for SQL Server",
+        )
+        encrypt = "yes" if click.confirm("Encrypt connection?", default=True) else "no"
+        trust = (
+            "yes"
+            if click.confirm("Trust server certificate?", default=True)
+            else "no"
+        )
+        params["driver"] = driver
+        params["Encrypt"] = encrypt
+        params["TrustServerCertificate"] = trust
+    else:
+        sslmode = click.prompt(
+            "SSL mode (leave blank to skip)",
+            default="",
+            show_default=False,
+        ).strip()
+        if sslmode:
+            params["sslmode"] = sslmode
+
+    extra = click.prompt(
+        "Additional query params (key=value&key2=value2, blank to skip)",
+        default="",
+        show_default=False,
+    ).strip()
+    if extra:
+        for chunk in extra.split("&"):
+            if "=" not in chunk:
+                continue
+            key, value = chunk.split("=", 1)
+            key = key.strip()
+            value = value.strip()
+            if key:
+                params[key] = value
+    return params
+
+
+def _build_connection_url(kind: str, default_scheme: str) -> str:
+    while True:
+        scheme = _prompt_connection_engine(kind, default_scheme)
+        default_port = 1433 if scheme == "mssql" else 5432
+        default_db = "master" if scheme == "mssql" else "postgres"
+        host = click.prompt("Host", default="localhost").strip()
+        port = click.prompt("Port", default=default_port, type=int)
+        database = click.prompt("Database name", default=default_db).strip()
+        username = click.prompt(
+            "Username (leave blank for none)",
+            default="",
+            show_default=False,
+        ).strip()
+        password = click.prompt(
+            "Password (leave blank for none)",
+            default="",
+            show_default=False,
+            hide_input=True,
+        )
+        params = _prompt_optional_params(scheme)
+
+        auth = ""
+        if username:
+            auth = quote_plus(username)
+            if password:
+                auth = f"{auth}:{quote_plus(password)}"
+            auth = f"{auth}@"
+        elif password:
+            auth = f":{quote_plus(password)}@"
+
+        host_part = host
+        if port:
+            host_part = f"{host}:{port}"
+
+        path = f"/{database}" if database else ""
+        query = "&".join(
+            f"{quote_plus(str(k))}={quote_plus(str(v))}" for k, v in params.items()
+        )
+        url = f"{scheme}://{auth}{host_part}{path}"
+        if query:
+            url = f"{url}?{query}"
+
+        click.echo(f"\nConstructed {kind} URL:\n{url}\n")
+        if click.confirm("Use this URL?", default=True):
+            return url
+        click.echo("Let's try building it again.\n")
+
+
+def _make_output_dir(base_out: Optional[str]) -> Path:
+    base = Path(base_out) if base_out else Path(DEFAULT_REPORTS_DIR)
+    out_dir = base / _timestamp()
+    out_dir.mkdir(parents=True, exist_ok=True)
+    return out_dir
+
+
+def _engine_info(conn) -> Dict[str, str]:
+    """Return a simple engine and version string for overview."""
+    try:
+        from ..core.connectors import MSSQLConnector, PostgresConnector
+
+        if isinstance(conn, MSSQLConnector):
+            row = conn.fetchone("SELECT @@VERSION")
+            return {"engine": "SQL Server", "version": (row[0] if row else "")}
+        if isinstance(conn, PostgresConnector):
+            row = conn.fetchone("SELECT version()")
+            return {"engine": "PostgreSQL", "version": (row[0] if row else "")}
+    except Exception:
+        pass
+    name = conn.__class__.__name__.replace("Connector", "")
+    return {"engine": name, "version": ""}
+
+
+__all__ = [
+    "DEFAULT_BEHAVIOUR_LIMIT",
+    "DEFAULT_BEHAVIOUR_TIMEOUT_S",
+    "DEFAULT_REPORTS_DIR",
+    "LOCAL_TZ",
+    "_build_connection_url",
+    "_engine_info",
+    "_make_output_dir",
+]