sourcemeta-jsonschema 14.0.2__tar.gz

sourcemeta_jsonschema-14.0.2/MANIFEST.in

@@ -0,0 +1,3 @@
+include README.md
+recursive-include sourcemeta_jsonschema *.exe
+recursive-include sourcemeta_jsonschema jsonschema-*

sourcemeta_jsonschema-14.0.2/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.4
+Name: sourcemeta_jsonschema
+Version: 14.0.2
+Summary: The CLI for working with JSON Schema. Covers formatting, linting, testing, and much more for both local development and CI/CD pipelines
+Home-page: https://github.com/sourcemeta/jsonschema
+Author: Sourcemeta
+Author-email: hello@sourcemeta.com
+License: AGPL-3.0
+Requires-Python: >=3.7
+Dynamic: author
+Dynamic: author-email
+Dynamic: home-page
+Dynamic: license
+Dynamic: requires-python
+Dynamic: summary

sourcemeta_jsonschema-14.0.2/README.md

@@ -0,0 +1,240 @@
+![JSON Schema](./assets/banner.png)
+
+[![GitHub Release](https://img.shields.io/github/v/release/sourcemeta/jsonschema)](https://github.com/sourcemeta/jsonschema/releases)
+[![NPM Version](https://img.shields.io/npm/v/@sourcemeta/jsonschema)](https://www.npmjs.com/package/@sourcemeta/jsonschema)
+[![NPM Downloads](https://img.shields.io/npm/dm/%40sourcemeta%2Fjsonschema)](https://www.npmjs.com/package/@sourcemeta/jsonschema)
+[![PyPI Version](https://img.shields.io/pypi/v/sourcemeta-jsonschema.svg)](https://pypi.org/project/sourcemeta-jsonschema)
+[![GitHub Actions](https://github.com/sourcemeta/jsonschema/actions/workflows/test.yml/badge.svg)](https://github.com/sourcemeta/jsonschema/actions)
+[![GitHub contributors](https://img.shields.io/github/contributors/sourcemeta/jsonschema.svg)](https://github.com/sourcemeta/jsonschema/graphs/contributors/)
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/sourcemeta/jsonschema/blob/main/.pre-commit-hooks.yaml)
+
+[![Get it from the Snap Store](https://snapcraft.io/en/light/install.svg)](https://snapcraft.io/jsonschema)
+
+The command-line tool for working with [JSON Schema](https://json-schema.org),
+the world most popular schema language. It is a comprehensive solution for
+maintaining **repositories of schemas** and ensuring their quality, both during
+local development and when running on CI/CD pipelines. For example:
+
+- Ensure your schemas are valid
+- Debug unexpected schema validation results
+- Unit test your schemas against valid and invalid instances
+- Enforce consistent indentation and keyword ordering in your schema files
+- Detect and fix common JSON Schema anti-patterns
+- Inline external references for conveniently distributing your schemas
+
+[**Check out the documentation to learn more**](#usage)
+
+***
+
+> [!TIP]
+> Do you want to level up your JSON Schema skills? Check out
+> [learnjsonschema.com](https://www.learnjsonschema.com), our growing JSON
+> Schema documentation website, our [JSON Schema for
+> OpenAPI](https://www.sourcemeta.com/courses/jsonschema-for-openapi) video
+> course, and our O'Reilly book [Unifying Business, Data, and Code: Designing
+> Data Products with JSON
+> Schema](https://www.oreilly.com/library/view/unifying-business-data/9781098144999/).
+
+***
+
+![JSON Schema CLI Example](./assets/example.png)
+
+Version support
+---------------
+
+We aim to fully support _every_ version of JSON Schema and combinations between them.
+
+| Dialect             | Support                                               |
+|---------------------|-------------------------------------------------------|
+| JSON Schema 2020-12 | **Full**                                              |
+| JSON Schema 2019-09 | **Full**                                              |
+| JSON Schema Draft 7 | **Full**                                              |
+| JSON Schema Draft 6 | **Full**                                              |
+| JSON Schema Draft 4 | **Full**                                              |
+| JSON Schema Draft 3 | Partial (except `validate`, `test`, and `metaschema`) |
+| JSON Schema Draft 2 | Partial (except `validate`, `test`, and `metaschema`) |
+| JSON Schema Draft 1 | Partial (except `validate`, `test`, and `metaschema`) |
+| JSON Schema Draft 0 | Partial (except `validate`, `test`, and `metaschema`) |
+
+What our users are saying
+-------------------------
+
+> Amazing product. Very useful for formatting and bundling my schemas, plus it
+> surfaced various referencing issues. 10 out of 10!
+
+[@alombarte](https://github.com/alombarte), co-founder of the
+[KrakenD](https://www.krakend.io) API Gateway.
+
+Usage
+-----
+
+The functionality provided by the JSON Schema CLI is divided into commands. The
+following pages describe each feature in detail. Additionally, running the JSON
+Schema CLI without passing a command will print convenient reference
+documentation:
+
+- [`jsonschema version`](./docs/version.markdown)
+- [`jsonschema validate`](./docs/validate.markdown)
+- [`jsonschema metaschema`](./docs/metaschema.markdown) (ensure a schema is valid)
+- [`jsonschema compile`](./docs/compile.markdown) (for pre-compiling schemas)
+- [`jsonschema test`](./docs/test.markdown) (write unit tests for your schemas)
+- [`jsonschema fmt`](./docs/format.markdown)
+- [`jsonschema lint`](./docs/lint.markdown)
+- [`jsonschema bundle`](./docs/bundle.markdown) (for inlining remote references in a schema)
+- [`jsonschema inspect`](./docs/inspect.markdown) (for debugging references)
+- [`jsonschema canonicalize`](./docs/canonicalize.markdown) (for static analysis)
+- [`jsonschema encode`](./docs/encode.markdown) (for binary compression)
+- [`jsonschema decode`](./docs/decode.markdown)
+
+> See [`jsonschema.json`](./docs/configuration.markdown) for an _experimental_
+manifest for describing JSON Schema data models inspired by NPM's
+`package.json`.
+
+Note that YAML is supported in most commands!
+
+We also support a growing amount of [`pre-commit`](https://pre-commit.com)
+hooks. Take a look at the
+[`.pre-commit-hooks.yaml`](https://github.com/sourcemeta/jsonschema/blob/main/.pre-commit-hooks.yaml)
+configuration file for what's available right now. Keep in mind that to use the
+`pre-commit` hooks, you need to install the CLI first.
+
+***
+
+If you are looking for more of a tutorial and overview of what the CLI is
+capable of, take a look at the [Applying software engineering practices to JSON
+Schemas](https://www.youtube.com/watch?v=wJ7bK22n3IU) talk from the 2024 [JSON
+Schema Conference](https://conference.json-schema.org). It covers advise on
+ontology design, linting, unit testing, CI/CD integration, and more:
+
+[![JSON Schema Conference 2024 - Applying software engineering practices to JSON Schemas](https://img.youtube.com/vi/wJ7bK22n3IU/0.jpg)](https://www.youtube.com/watch?v=wJ7bK22n3IU)
+
+Installation
+------------
+
+The JSON Schema CLI is written using C++ and [CMake](https://cmake.org/), and
+supports macOS, Windows, and GNU/Linux.
+
+### From Homebrew
+
+```sh
+brew install sourcemeta/apps/jsonschema
+```
+
+### From GitHub Actions
+
+```yaml
+- uses: sourcemeta/jsonschema@vX.Y.Z
+```
+
+Where `X.Y.Z` is replaced with the desired version. For example:
+
+```yaml
+- name: Checkout Repository
+  uses: actions/checkout@v4
+
+- name: Install the JSON Schema CLI
+  uses: sourcemeta/jsonschema@v14.0.2
+
+# Then use as usual
+- run: jsonschema fmt path/to/schemas --check
+```
+
+### From npm
+
+```sh
+npm install --global @sourcemeta/jsonschema
+```
+
+### From PyPI
+
+```sh
+pip install sourcemeta-jsonschema
+```
+
+### From mise
+
+```sh
+mise use jsonschema
+```
+
+### From GitHub Releases
+
+We publish precompiled binaries for every supported platform to [GitHub
+Releases](https://github.com/sourcemeta/jsonschema/releases), including a
+[continuous](https://github.com/sourcemeta/jsonschema/releases/tag/continuous)
+that is updated on every commit from the main branch.
+
+For convenience, we also provide a POSIX shell script capable of installing the
+latest pre-built binaries, which you can run as follows:
+
+```sh
+curl -fsSL https://raw.githubusercontent.com/sourcemeta/jsonschema/main/install -H 'Cache-Control: no-cache, no-store, must-revalidate' | /bin/sh
+```
+
+Keep in mind that it is hard to provide binaries that work across GNU/Linux
+distributions, given they often have major differences such as C runtimes (GLIC
+vs MUSL). We conservatively target Ubuntu 22.04, but you might need to build
+from source if your distribution of choice is different.
+
+To verify the GPG signature of the checksums file:
+
+```sh
+curl --silent --show-error --location 'https://www.sourcemeta.com/gpg.asc' | gpg --import
+gpg --verify CHECKSUMS.txt.asc CHECKSUMS.txt
+```
+
+### From Dockerfile
+
+Starting from v7.2.1, we publish a Docker image to [GitHub
+Packages](https://github.com/sourcemeta/jsonschema/pkgs/container/jsonschema)
+(`amd64` and `arm64`), which you can use as follows:
+
+```sh
+docker run --interactive --volume "$PWD:/workspace" \
+  ghcr.io/sourcemeta/jsonschema:vX.Y.Z lint --verbose myschema.json
+```
+
+Replace `vX.Y.Z` with your desired version. You can mount any directory as `/workspace`.
+
+> [!WARNING]
+> Make sure to NOT allocate a pseudo-TTY when running the CLI through Docker
+> (i.e. the `--tty`/`-t` option) as it might result in line ending
+> incompatibilities between the container and host, which will affect
+> formatting. Plus a TTY is not required for running a tool like the JSON
+> Schema CLI.
+
+### From Snap
+
+Starting from v10.0.0, we publish to the Snap store:
+
+```sh
+sudo snap install jsonschema
+```
+
+Keep in mind that due to [Snap
+confinement](https://snapcraft.io/docs/snap-confinement) requirements, the Snap
+is only able to access files under your `$HOME` directory.
+
+### With gah
+
+If you are using [gah](https://github.com/marverix/gah):
+
+```sh
+gah install jsonschema
+```
+
+gah does not require sudo, but you need to have `$HOME/.local/bin/` in your `PATH`.
+
+### Building from source
+
+```sh
+git clone https://github.com/sourcemeta/jsonschema
+cd jsonschema
+cmake -S . -B ./build -DCMAKE_BUILD_TYPE:STRING=Release
+cmake --build ./build --config Release --parallel 4
+cmake --install ./build --prefix <prefix> \
+  --config Release --verbose --component sourcemeta_jsonschema
+```
+
+Where `<prefix>` can be any destination prefix of your choosing, such as `/opt`
+or `/usr/local`.

sourcemeta_jsonschema-14.0.2/setup.cfg

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

sourcemeta_jsonschema-14.0.2/setup.py

@@ -0,0 +1,22 @@
+from setuptools import setup, find_packages
+
+setup(
+    name         = "sourcemeta_jsonschema",
+    version      = "14.0.2",
+    description  = "The CLI for working with JSON Schema. Covers formatting, linting, testing, and much more for both local development and CI/CD pipelines",
+    author       = "Sourcemeta",
+    author_email = "hello@sourcemeta.com",
+    url          = "https://github.com/sourcemeta/jsonschema",
+    license      = "AGPL-3.0",
+    packages     = find_packages(),
+    include_package_data = True,
+    package_data = {
+        "sourcemeta_jsonschema": ["*.exe", "jsonschema-*"]
+    },
+    python_requires = ">=3.7",
+    entry_points = {
+        "console_scripts": [
+            "jsonschema = sourcemeta_jsonschema.__main__:main"
+        ]
+    }
+)

sourcemeta_jsonschema-14.0.2/sourcemeta_jsonschema/__main__.py

@@ -0,0 +1,20 @@
+import os, platform, subprocess, sys
+
+def main():
+    arch_map = {
+        'amd64': 'x86_64'
+    }
+
+    system = platform.system().lower()
+    arch   = platform.machine().lower()
+    arch   = arch_map.get(arch, arch)
+    key    = f"{system}-{arch}"
+    fn     = f"jsonschema-{key}.exe" if system=="windows" else f"jsonschema-{key}"
+    path   = os.path.join(os.path.dirname(__file__), fn)
+    if not os.path.exists(path):
+        print(f"Unsupported platform: {key}", file=sys.stderr)
+        sys.exit(1)
+    subprocess.run([path]+sys.argv[1:], check=True)
+
+if __name__=="__main__":
+    main()

sourcemeta_jsonschema-14.0.2/sourcemeta_jsonschema.egg-info/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.4
+Name: sourcemeta_jsonschema
+Version: 14.0.2
+Summary: The CLI for working with JSON Schema. Covers formatting, linting, testing, and much more for both local development and CI/CD pipelines
+Home-page: https://github.com/sourcemeta/jsonschema
+Author: Sourcemeta
+Author-email: hello@sourcemeta.com
+License: AGPL-3.0
+Requires-Python: >=3.7
+Dynamic: author
+Dynamic: author-email
+Dynamic: home-page
+Dynamic: license
+Dynamic: requires-python
+Dynamic: summary

sourcemeta_jsonschema-14.0.2/sourcemeta_jsonschema.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+MANIFEST.in
+README.md
+setup.py
+sourcemeta_jsonschema/__init__.py
+sourcemeta_jsonschema/__main__.py
+sourcemeta_jsonschema/jsonschema-darwin-arm64
+sourcemeta_jsonschema/jsonschema-darwin-x86_64
+sourcemeta_jsonschema/jsonschema-linux-arm64
+sourcemeta_jsonschema/jsonschema-linux-x86_64
+sourcemeta_jsonschema/jsonschema-windows-x86_64.exe
+sourcemeta_jsonschema.egg-info/PKG-INFO
+sourcemeta_jsonschema.egg-info/SOURCES.txt
+sourcemeta_jsonschema.egg-info/dependency_links.txt
+sourcemeta_jsonschema.egg-info/entry_points.txt
+sourcemeta_jsonschema.egg-info/top_level.txt

sourcemeta_jsonschema-14.0.2/sourcemeta_jsonschema.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

sourcemeta_jsonschema-14.0.2/sourcemeta_jsonschema.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+jsonschema = sourcemeta_jsonschema.__main__:main

sourcemeta_jsonschema-14.0.2/sourcemeta_jsonschema.egg-info/top_level.txt

@@ -0,0 +1 @@
+sourcemeta_jsonschema