Merge pull request networktocode#134 from networktocode/issue-133

Add jsonschema format checker installation that does not install GPL-…

Author: PhillSimonds

CHANGELOG.md

@@ -1,11 +1,19 @@
 # Changelog
 
-## v1.1.4 - 2022-06-16
+## v1.1.4 - TBD
+
+### Adds
+
+- Add format_nongpl extra to jsonschema install. This ensures draft7 format checkers validate format adherence as expected while also ensuring GPL-Licenced transitive dependencies are not installed.
 
 ### Changes
 
 - Update jsonschema schema version dependency so that only versions greater than 4.4 are supported.
 
+### Removes
+
+- Automatic support for `iri` and `iri-reference` format checkers. This was removed because these format checkers require the `rfc3987` library, which is licensed under GPL. If you require these checkers, you can manually install `rfc3987` or install this package as `jsonschema[rfc3987]`.
+
 ## v1.1.3 - 2022-05-31
 
 ### Changes

README.md

@@ -189,6 +189,17 @@ bash$ cat pyproject.toml
 ```
 
 > More information on available configuration settings can be found in the [configuration README](docs/configuration.md)
+
+### Supported Formats
+
+By default, schema enforcer installs the jsonschema `format-nongpl` extra which allows the use of formats that can be used in schema definitions (e.g. ipv4, hostname...etc). The `format-nongpl` extra only installs transitive dependencies that are not licensed under GPL. The `iri` and `iri-reference` formats are defined by the `rfc3987` transitive dependency which is licensed under GPL. As such, `iri` and `iri-reference` formats are *not* supported by `format-nongpl`. If you have a need to use `iri` and/or `iri-reference` formats, you can do so by running the following pip command (or it's poetry equivalent):
+
+```
+pip install 'jsonschema[rfc3987]'
+```
+
+See the "Validating Formats" section in the [jsonschema documentation](https://github.com/python-jsonschema/jsonschema/blob/main/docs/validate.rst) for more information.
+
 ### Where To Go Next
 
 Detailed documentation can be found in the README.md files inside of the `docs/` directory.

poetry.lock

@@ -17,20 +17,17 @@ include = [
 python = "^3.7"
 click = "^7.1 || ^8.0"
 termcolor = "^1.1"
-jsonschema = {version = "^4.4", extras = ["format"]}
 toml = "^0.10"
 "ruamel.yaml" = "^0.16 || ^0.17"
 jinja2 = ">=2.11"
 jsonref = "^0.2"
 pydantic = "^1.6"
 rich = "^9.5"
-rfc3987 = "^1.3"
 jsonpointer = "^2.1"
-strict-rfc3339 = "^0.7"
-rfc3339-validator = "^0.1"
 jmespath = "^0.10"
 ansible = { version = "^2.10.0", optional = true }
 ansible-base = { version = "^2.10.0", optional = true }
+jsonschema = {version = "^4.7.1", extras = ["format-nongpl"]}
 
 [tool.poetry.extras]
 ansible = ["ansible"]

pyproject.toml

@@ -17,7 +17,6 @@
  "incorrect_ipv6_format": "'2001:00000:3238:DFE1:63:0000:0000:FEFB' is not a 'ipv6'",
  "incorrect_time_format": "'20:20:33333+00:00' is not a 'time'",
  "incorrect_datetime_format": "'January 29th 2021' is not a 'date-time'",
- "incorrect_iri_format": "'fake_iri' is not a 'iri'",
 }