jspprint 0.1.0__tar.gz

jspprint-0.1.0/.gitignore

@@ -0,0 +1,220 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer,
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+.DS_Store
+
+.claude

jspprint-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright @ 2026 Jyrki Kokkola
+
+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.

jspprint-0.1.0/PKG-INFO

@@ -0,0 +1,84 @@
+Metadata-Version: 2.4
+Name: jspprint
+Version: 0.1.0
+Summary: A CLI tool for viewing and manipulating JSON files
+Project-URL: Homepage, https://github.com/jyjokokk/jsp
+Project-URL: Repository, https://github.com/jyjokokk/jsp
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Utilities
+Requires-Python: >=3.12
+Requires-Dist: rich>=14.3.3
+Requires-Dist: typer>=0.24.1
+Description-Content-Type: text/markdown
+
+# jsp
+
+A CLI tool for viewing and manipulating JSON files. Pretty-prints JSON with syntax highlighting by default, supports filtering by keys, and allows in-memory modifications for easy piping — without altering the original file.
+
+## Features
+
+- **Pretty-print JSON** with syntax highlighting (default behavior)
+- **Filter by key(s)** to extract and display specific parts of a JSON structure
+- **In-memory modifications** — add, update, replace, or delete values in the output without touching the source file
+- **Merge from file or stdin** — set a key's value to the contents of another JSON file, or pipe JSON in via stdin
+- **Stdin as input** — read JSON from stdin instead of a file (`cat data.json | jsp`)
+- **Pipe-friendly** — output can be piped to other commands or redirected to files
+
+## Planned
+
+- CSV, XML, and YAML support
+
+## Tech Stack
+
+- **Python**
+- **Rich** for colored/syntax-highlighted output
+- **Typer** for argument parsing
+
+## Installation
+
+> Coming soon — Homebrew tap planned as the first distribution target.
+
+## Usage
+
+```sh
+# Pretty-print a JSON file with syntax highlighting
+jsp data.json
+
+# Read JSON from stdin
+cat data.json | jsp
+
+# Filter by key
+jsp data.json name
+
+# Filter by nested key path
+jsp data.json users.0.email
+
+# Modify a value in the output (file is not changed)
+jsp data.json --set name=updated
+
+# Delete a key from the output
+jsp data.json --del obsoleteField
+
+# Set a key's value from another JSON file
+jsp data.json --set config=@overrides.json
+
+# Same thing via stdin pipe
+cat overrides.json | jsp data.json --set config=@-
+
+# Output compact JSON (single line, no highlighting)
+jsp data.json --compact
+jsp data.json -c
+
+# Pipe the result
+jsp data.json --set env=prod -c | kubectl apply -f -
+```
+
+## License
+
+MIT

jspprint-0.1.0/README.md

@@ -0,0 +1,65 @@
+# jsp
+
+A CLI tool for viewing and manipulating JSON files. Pretty-prints JSON with syntax highlighting by default, supports filtering by keys, and allows in-memory modifications for easy piping — without altering the original file.
+
+## Features
+
+- **Pretty-print JSON** with syntax highlighting (default behavior)
+- **Filter by key(s)** to extract and display specific parts of a JSON structure
+- **In-memory modifications** — add, update, replace, or delete values in the output without touching the source file
+- **Merge from file or stdin** — set a key's value to the contents of another JSON file, or pipe JSON in via stdin
+- **Stdin as input** — read JSON from stdin instead of a file (`cat data.json | jsp`)
+- **Pipe-friendly** — output can be piped to other commands or redirected to files
+
+## Planned
+
+- CSV, XML, and YAML support
+
+## Tech Stack
+
+- **Python**
+- **Rich** for colored/syntax-highlighted output
+- **Typer** for argument parsing
+
+## Installation
+
+> Coming soon — Homebrew tap planned as the first distribution target.
+
+## Usage
+
+```sh
+# Pretty-print a JSON file with syntax highlighting
+jsp data.json
+
+# Read JSON from stdin
+cat data.json | jsp
+
+# Filter by key
+jsp data.json name
+
+# Filter by nested key path
+jsp data.json users.0.email
+
+# Modify a value in the output (file is not changed)
+jsp data.json --set name=updated
+
+# Delete a key from the output
+jsp data.json --del obsoleteField
+
+# Set a key's value from another JSON file
+jsp data.json --set config=@overrides.json
+
+# Same thing via stdin pipe
+cat overrides.json | jsp data.json --set config=@-
+
+# Output compact JSON (single line, no highlighting)
+jsp data.json --compact
+jsp data.json -c
+
+# Pipe the result
+jsp data.json --set env=prod -c | kubectl apply -f -
+```
+
+## License
+
+MIT

jspprint-0.1.0/pyproject.toml

@@ -0,0 +1,39 @@
+[project]
+name = "jspprint"
+version = "0.1.0"
+description = "A CLI tool for viewing and manipulating JSON files"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.12"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Topic :: Utilities",
+]
+dependencies = ["rich>=14.3.3", "typer>=0.24.1"]
+
+[project.scripts]
+jsp = "jsp.cli:app"
+
+[project.urls]
+Homepage = "https://github.com/jyjokokk/jsp"
+Repository = "https://github.com/jyjokokk/jsp"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/jsp"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/jsp/", "README.md", "LICENSE", "pyproject.toml"]
+
+[dependency-groups]
+dev = ["pytest>=9.0.2", "ruff>=0.15.5"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

jspprint-0.1.0/src/jsp/cli.py

@@ -0,0 +1,85 @@
+import json
+import sys
+from typing import Optional
+
+import typer
+
+from jsp.io import filter_by_key, print_json, read_json, update_json
+
+app = typer.Typer()
+
+
+@app.command()
+def main(
+    file: Optional[str] = typer.Argument(
+        None, help="Path to a JSON file. Reads from stdin if omitted."
+    ),
+    key: Optional[str] = typer.Argument(
+        None, help="Key to filter by, using dot notation (e.g. users.0.email)."
+    ),
+    compact: bool = typer.Option(
+        False, "--compact", "-c", help="Output compact JSON without formatting."
+    ),
+    set_value: Optional[list[str]] = typer.Option(
+        None, "--set", "-s", help="Set a value: key=value or key=@file.json."
+    ),
+    delete: Optional[list[str]] = typer.Option(
+        None, "--del", "-d", help="Delete a key from the output."
+    ),
+) -> None:
+    """A CLI tool for viewing and manipulating JSON files."""
+    stdin_used = file is None
+    try:
+        data = read_json(file)
+    except ValueError as e:
+        raise typer.BadParameter(str(e)) from e
+
+    if set_value:
+        for item in set_value:
+            k, _, v = item.partition("=")
+            if not k or not v:
+                raise typer.BadParameter(
+                    f"Invalid --set format: '{item}'. Use key=value."
+                )
+            if v == "@-":
+                if stdin_used:
+                    raise typer.BadParameter(
+                        "Cannot use @- (stdin) for --set when stdin is already used as primary input."
+                    )
+                v = json.load(sys.stdin)
+            elif v.startswith("@"):
+                with open(v[1:]) as f:
+                    v = json.load(f)
+            else:
+                try:
+                    v = json.loads(v)
+                except json.JSONDecodeError:
+                    pass  # keep as string
+            data = update_json(data, k, v)
+
+    if delete:
+        from jsp.io import _traverse
+
+        for k in delete:
+            try:
+                parent, last_key = _traverse(data, k, stop_before_last=True)
+                if isinstance(parent, dict) and last_key in parent:
+                    del parent[last_key]
+                elif isinstance(parent, list) and last_key.isdigit():
+                    del parent[int(last_key)]
+                else:
+                    raise KeyError(f"Key '{k}' not found in the data.")
+            except KeyError as e:
+                raise typer.BadParameter(str(e)) from e
+
+    if key:
+        try:
+            data = filter_by_key(data, key)
+        except KeyError as e:
+            raise typer.BadParameter(str(e)) from e
+
+    print_json(data, pretty=not compact)
+
+
+if __name__ == "__main__":
+    app()

jspprint-0.1.0/src/jsp/io.py

@@ -0,0 +1,78 @@
+"""Functions for handling STDIN and STDOUT operations."""
+
+import json
+import sys
+from typing import Any
+
+from rich.console import Console
+
+console = Console()
+
+
+def read_json(file_path: str | None = None) -> dict:
+    """Read JSON from a file path or stdin if no path is given."""
+    try:
+        if file_path:
+            with open(file_path) as f:
+                return json.load(f)
+
+        if not sys.stdin.isatty():
+            return json.load(sys.stdin)
+    except json.JSONDecodeError as e:
+        source = file_path or "stdin"
+        raise ValueError(f"Invalid JSON from {source}: {e}") from e
+
+    raise ValueError("No input provided. Pass a file path or pipe JSON via stdin.")
+
+
+def print_json(data: dict, pretty: bool = True) -> None:
+    if pretty:
+        console.print_json(json.dumps(data, indent=4))
+    else:
+        print(json.dumps(data))
+
+
+def _traverse(data, key: str, stop_before_last: bool = False) -> tuple[Any, str] | Any:
+    """Traverse data using dot notation. Returns (parent, last_key) if stop_before_last, else the value."""
+    keys = key.split(".")
+    traverse_keys = keys[:-1] if stop_before_last else keys
+    current = data
+
+    for k in traverse_keys:
+        if isinstance(current, list) and k.isdigit():
+            index = int(k)
+            if index < len(current):
+                current = current[index]
+            else:
+                raise KeyError(f"Index {index} out of range in '{key}'.")
+        elif isinstance(current, dict) and k in current:
+            current = current[k]
+        else:
+            raise KeyError(f"Key '{key}' not found in the data.")
+
+    if stop_before_last:
+        return current, keys[-1]
+    return current
+
+
+def filter_by_key(data: dict, key: str) -> dict:
+    """Filter a dictionary by a key, supporting dot notation for nested access."""
+    return {key: _traverse(data, key)}
+
+
+def update_json(data: dict, key: str, value) -> dict:
+    """Modify a dictionary with a new value at a specified key, supporting dot notation."""
+    parent, last_key = _traverse(data, key, stop_before_last=True)
+
+    if isinstance(parent, list) and last_key.isdigit():
+        index = int(last_key)
+        if index < len(parent):
+            parent[index] = value
+        else:
+            raise KeyError(f"Index {index} out of range in '{key}'.")
+    elif isinstance(parent, dict):
+        parent[last_key] = value
+    else:
+        raise KeyError(f"Cannot set value at '{key}'.")
+
+    return data