schema-drift-cli 0.1.0__tar.gz

schema_drift_cli-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Syed Maarif R.
+
+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.

schema_drift_cli-0.1.0/PKG-INFO

@@ -0,0 +1,77 @@
+Metadata-Version: 2.4
+Name: schema-drift-cli
+Version: 0.1.0
+Summary: Detect schema drift in JSON APIs
+License-File: LICENSE
+Requires-Python: >=3.9
+Requires-Dist: requests>=2.31.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: typer[all]
+Provides-Extra: dev
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Schema Drift Detector - CLI
+
+Schema Drift Detector is a CLI that: 
+- Fetches a JSON payload from an HTTP API endpoint (GET for v1).
+- Loads a “baseline” schema from a local file (JSON).
+- Compares structure: added/removed/changed fields, type changes, optional vs required.
+- Outputs the diff in three formats: JSON, Markdown, and a pretty terminal table.
+
+## Language & Stack
+
+I used Python and Click for the CLI as they make argument parsing, subcommands, and help text clean and maintainable.
+
+## Output Examples
+
+### JSON:
+Simple: 
+```bash 
+print(json.dumps(diff, indent=2))
+```
+Good for machines and CI logs.
+
+### Markdown:
+```text
+### Added fields
+
+| Path              | Type   |
+|-------------------|--------|
+| `user.middle_name`| string |
+```
+
+### Pretty Terminal Table:
+```text
+ADDED | user.middle_name | - | string
+```
+
+## Installation
+
+Use the package manager [pip](https://pypi.org/project/reorder-editable/) to install reorder-editable.
+
+```bash
+pip install -e .
+```
+
+## Usage
+
+```bash
+python -m schema_drift_cli --help
+```
+
+### Commands
+
+- `version` - Shows the CLI version
+
+## Contributing
+
+Pull requests are welcome. For major changes, please open an issue first
+to discuss what you would like to change.
+
+Please make sure to update tests as appropriate.
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)

schema_drift_cli-0.1.0/README.md

@@ -0,0 +1,63 @@
+# Schema Drift Detector - CLI
+
+Schema Drift Detector is a CLI that: 
+- Fetches a JSON payload from an HTTP API endpoint (GET for v1).
+- Loads a “baseline” schema from a local file (JSON).
+- Compares structure: added/removed/changed fields, type changes, optional vs required.
+- Outputs the diff in three formats: JSON, Markdown, and a pretty terminal table.
+
+## Language & Stack
+
+I used Python and Click for the CLI as they make argument parsing, subcommands, and help text clean and maintainable.
+
+## Output Examples
+
+### JSON:
+Simple: 
+```bash 
+print(json.dumps(diff, indent=2))
+```
+Good for machines and CI logs.
+
+### Markdown:
+```text
+### Added fields
+
+| Path              | Type   |
+|-------------------|--------|
+| `user.middle_name`| string |
+```
+
+### Pretty Terminal Table:
+```text
+ADDED | user.middle_name | - | string
+```
+
+## Installation
+
+Use the package manager [pip](https://pypi.org/project/reorder-editable/) to install reorder-editable.
+
+```bash
+pip install -e .
+```
+
+## Usage
+
+```bash
+python -m schema_drift_cli --help
+```
+
+### Commands
+
+- `version` - Shows the CLI version
+
+## Contributing
+
+Pull requests are welcome. For major changes, please open an issue first
+to discuss what you would like to change.
+
+Please make sure to update tests as appropriate.
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)

schema_drift_cli-0.1.0/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "schema-drift",
+  "version": "0.1.0",
+  "description": "Detect schema drift and breaking changes in your JSON APIs. Initialize a basline schema, then continuously check for structural changes. Get clear reports on what's changed and where. Perfect for API monitoring, CI/CD validation, and catching unintended data structure changes before they break production.",
+  "main": "pyproject.toml",
+  "scripts": {
+    "test": "pytest"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MrFrayman/Schema-Drift-Detector-CLI.git"
+  },
+  "keywords": [
+    "schema-drift",
+    "schema",
+    "validation",
+    "json",
+    "validation",
+    "api",
+    "monitoring",
+    "breaking",
+    "changes",
+    "api",
+    "diff",
+    "data",
+    "contract",
+    "change",
+    "detection"
+  ],
+  "author": "Syed Maarif R.",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/MrFrayman/Schema-Drift-Detector-CLI/issues"
+  },
+  "homepage": "https://github.com/MrFrayman/Schema-Drift-Detector-CLI#readme"
+}

schema_drift_cli-0.1.0/pyproject.toml

@@ -0,0 +1,24 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "schema-drift-cli"
+version = "0.1.0"
+description = "Detect schema drift in JSON APIs"
+readme = "README.md"
+requires-python = ">=3.9"
+dependencies = [
+    "typer[all]",
+    "rich>=13.0.0",
+    "requests>=2.31.0",
+]
+
+[project.scripts]
+schema-drift = "schema_drift_cli:main"
+
+[project.optional-dependencies]
+dev = [
+    "pytest",
+    "ruff",
+]

schema_drift_cli-0.1.0/schema_drift_cli/__init__.py

@@ -0,0 +1,3 @@
+from schema_drift_cli.cli import main
+
+__all__ = ["main"]

schema_drift_cli-0.1.0/schema_drift_cli/__main__.py

@@ -0,0 +1,4 @@
+from schema_drift_cli.cli import main
+
+if __name__ == "__main__":
+    main()

schema_drift_cli-0.1.0/schema_drift_cli/cli.py

@@ -0,0 +1,73 @@
+import typer
+
+# The typer application object
+app = typer.Typer(help="Schema Drift Detector CLI")
+
+@app.callback(invoke_without_command=True)
+def on_startup(ctx: typer.Context) -> None:
+    """Schema Drift Detector CLI"""
+    if ctx.invoked_subcommand is None:
+        ascii_art = """
+███████╗ ██████╗██╗  ██╗███████╗███╗   ███╗ █████╗     ██████╗ ██████╗ ██╗███████╗████████╗
+██╔════╝██╔════╝██║  ██║██╔════╝████╗ ████║██╔══██╗    ██╔══██╗██╔══██╗██║██╔════╝╚══██╔══╝
+███████╗██║     ███████║█████╗  ██╔████╔██║███████║    ██║  ██║██████╔╝██║█████╗     ██║   
+╚════██║██║     ██╔══██║██╔══╝  ██║╚██╔╝██║██╔══██║    ██║  ██║██╔══██╗██║██╔══╝     ██║   
+███████║╚██████╗██║  ██║███████╗██║ ╚═╝ ██║██║  ██║    ██████╔╝██║  ██║██║██║        ██║   
+╚══════╝ ╚═════╝╚═╝  ╚═╝╚══════╝╚═╝     ╚═╝╚═╝  ╚═╝    ╚═════╝ ╚═╝  ╚═╝╚═╝╚═╝        ╚═╝   
+                                                                                        
+"""
+        typer.echo(ascii_art)
+        typer.echo("Welcome to the Schema Drift Detector CLI!")
+        typer.echo("Use --help for more information")
+
+
+@app.command()
+def version() -> None:
+    """
+    Show the version of the schema-drift CLI
+    """
+    typer.echo("schema-drift version 0.1.0")
+
+@app.command()
+def init(
+    url: str = typer.Option(None, "--url", "-u", help="API URL to fetch baseline from"),
+    file: str = typer.Option(None, "--file","-f",help="Local JSON file to use as baseline"),
+    out: str = typer.Option("schema.json", "--out", "-o", help="Output schema file")
+) -> None:
+    """
+    Initialize a baseline schema from an API URL or a local JSON file.
+    """
+    typer.echo("Initializing baseline schema...")
+    typer.echo(f"Source: {url or file or 'none specified'}")
+    typer.echo(f"Output: {out}")
+    typer.echo("Done! (This is just a dummy version tho, real ones coming later)")
+
+@app.command()
+def check(
+    url: str = typer.Option(None, "--url", "-u", help="API URL to check"),
+    file: str = typer.Option(None, "--file","-f", help="Local JSON file to check"),
+    schema: str = typer.Option("schema.json", "--schema", "-s", help="Baseline schema file"),
+    output_format: str = typer.Option("table", "--output-format", "-of", help="Output format (json, markdown, table, all)"),
+    fail_on_drift: bool = typer.Option(False, "--fail-on-drift", "-fod", help="Exit 1 if drift detected")
+) -> None:
+    """
+    Check the current JSON against baseline schema.
+    """
+    typer.echo("Checking for schema drift...")
+    typer.echo(f"Live Data: {url or file or 'none'}")
+    typer.echo(f"Schema: {schema}")
+    typer.echo(f"Format: {output_format}")
+    typer.echo("No Drift Detected! (This is just a dummy version asw)")
+
+    if fail_on_drift:
+        typer.echo("    (fail-on-drift flag ignored for now)")
+
+def main() -> None:
+#     # Entrypoint that runs the Typer app
+    app()
+
+
+if __name__ == "__main__":
+    # When I run this file directly with `python schema_drift_cli/cli.py`
+    # Python sets __name__ to "__main__" and this block executes.
+    main()