{ "info": { "author": "Denis Blanchette, AbdulRahman Al Hamali", "author_email": "tools@coveo.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: Apache Software License", "Operating System :: OS Independent", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.7", "Topic :: Documentation" ], "description": "# JSON Schema for Humans\n\nQuickly generate a beautiful HTML static page documenting a JSON schema\n\n[Documentation](https://coveooss.github.io/json-schema-for-humans)\n\n## Installation\n```\npip install json-schema-for-humans\n```\n\n## Usage\n\n```\ngenerate-schema-doc [OPTIONS] SCHEMA_FILE [RESULT_FILE]\n```\n\n`SCHEMA_FILE` must be a valid JSON Schema\n\nA CSS file will be copied in the same directory as `RESULT_FILE`\n\nThe default value for `RESULT_FILE` is `schema_doc.html`\n\n## Options\n\n### --minify/--no-minify\nOn by default\n\nMinify the output HTML document\n\n### --deprecated-from-description\nOff by default\n\nMark a property as deprecated (with a big red badge) if the description contains the string `[Deprecated`\n\n### --default-from-description\nOff by default\n\nExtract the default value of a property from the description like this: ``[Default `the_default_value`]``\n\nThe default value from the \"default\" attribute will be used in priority\n\n## What's supported\n\nSee the excellent [Understanding JSON Schema](https://json-schema.org/understanding-json-schema/index.html) to understand what are those checks\n\nThe following are supported:\n- Types\n- Regular expressions\n- Numeric types multiples and range\n- Constant and enumerated values\n- Required properties\n- Default values\n- Array `minItems`, `maxItems`, `uniqueItems`, `items` (schema that must apply to all of the array items), and `contains`\n- Combining schema with `oneOf`, `allOf`, `anyOf`, and `not`\n\nThese are **not** supported at the moment (PRs welcome!):\n- String length and format\n- Property names, size, and pattern\n- Array items at specific index (for example, first item must be a string and second must be an integer)\n- Property dependencies\n- Examples\n- Media\n- Conditional subschemas\n\nReferences from inside a schema are supported (for example `{ $ref: \"#/definitions/something\" }` will be replaced by the \ncontent of `schema[\"definitions\"][\"something\"]`)\n\nReferences to schemas in other files are not supported for now.\n\n## Development\n\n### Testing\nJust run tox\n\n`tox`\n\n### Generating doc\nThe documentation is generated using jekyll and hosted on GitHub Pages\n\n- Change your current working directory to `docs`\n- Run ``python generate_examples.py``. This will get all examples from `tests/cases`, render the resulting HTML and\n include it in the appropriate folders in the jekyll site.\n- If you have added an example, add the file name (without `.json`), the display name and description in `_data/examples.yaml`\n\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/coveooss/json-schema-for-humans", "keywords": "", "license": "Apache Software License", "maintainer": "", "maintainer_email": "", "name": "json-schema-for-humans", "package_url": "https://pypi.org/project/json-schema-for-humans/", "platform": "", "project_url": "https://pypi.org/project/json-schema-for-humans/", "project_urls": { "Homepage": "https://github.com/coveooss/json-schema-for-humans" }, "release_url": "https://pypi.org/project/json-schema-for-humans/0.2.4/", "requires_dist": [ "click", "htmlmin", "jinja2", "markdown2" ], "requires_python": ">=3.6", "summary": "Generate static HTML documentation from JSON schemas", "version": "0.2.4" }, "last_serial": 5823219, "releases": { "0.2.1": [ { "comment_text": "", "digests": { "md5": "f8964a4b0a2c703fc9c4dd3159e5fed3", "sha256": "8759162630c8a59b9d2d72ffb09bb1b3c00f2f248797db84a8b43d1ec1abe9d4" }, "downloads": -1, "filename": "json_schema_for_humans-0.2.1-py3-none-any.whl", "has_sig": false, "md5_digest": "f8964a4b0a2c703fc9c4dd3159e5fed3", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 10433, "upload_time": "2019-09-11T20:54:48", "url": "https://files.pythonhosted.org/packages/d6/67/dbb3c79d04ff476b71f707b4e0c0bc1415ceb0d890526cec5bec1108ff06/json_schema_for_humans-0.2.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c18c52270c57b814e41fdea6b7f680a1", "sha256": "b1dee1a0b053a21ca32c220ceb3573f1e6db90ee3e5c47e4723e302075d3d5d6" }, "downloads": -1, "filename": "json-schema-for-humans-0.2.1.tar.gz", "has_sig": false, "md5_digest": "c18c52270c57b814e41fdea6b7f680a1", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 12995, "upload_time": "2019-09-11T20:54:49", "url": "https://files.pythonhosted.org/packages/ef/97/f13611591813f762dbf7e40b92704ee7482d48a37f659c953bfdbfcd64d2/json-schema-for-humans-0.2.1.tar.gz" } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "ab745cd28c630714ad7e79e189026788", "sha256": "245ff5f4559ff1bcaeb7209cb4c5d7a695c6a2a00dca3b245813db593e998759" }, "downloads": -1, "filename": "json_schema_for_humans-0.2.2-py3-none-any.whl", "has_sig": false, "md5_digest": "ab745cd28c630714ad7e79e189026788", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 11036, "upload_time": "2019-09-11T21:12:37", "url": "https://files.pythonhosted.org/packages/3f/13/a1abd3febd5ecb137935a7bb188bdeae24ef5ac0fadd1a123ac42128bc42/json_schema_for_humans-0.2.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b5632fed97b221392348ab617c42051c", "sha256": "01b0f42d3412079bb28bf21764edb7dae3e5dc482f26d00957decc55c6406566" }, "downloads": -1, "filename": "json-schema-for-humans-0.2.2.tar.gz", "has_sig": false, "md5_digest": "b5632fed97b221392348ab617c42051c", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 13356, "upload_time": "2019-09-11T21:12:38", "url": "https://files.pythonhosted.org/packages/b3/15/1d2478b8ab9cad54e71fbdd87af2a64f66b03b86149d63ed7935858d65ed/json-schema-for-humans-0.2.2.tar.gz" } ], "0.2.3": [ { "comment_text": "", "digests": { "md5": "7aae719d78cf0c6e9f582595dcb20a55", "sha256": "f4c18d4f1a39f693fd86f0a1d6bd6d19ddb8d9ce3570b0c2abadef76051d3700" }, "downloads": -1, "filename": "json_schema_for_humans-0.2.3-py3-none-any.whl", "has_sig": false, "md5_digest": "7aae719d78cf0c6e9f582595dcb20a55", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 11271, "upload_time": "2019-09-12T15:56:51", "url": "https://files.pythonhosted.org/packages/c4/7b/82b78ced5c499b9dd4928a7eb595eae96b4e58168ac1b7fb4312c00c72dd/json_schema_for_humans-0.2.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "80624864198c58e4eda4dd9612a99532", "sha256": "aa3cad958a3a6270443640c525f9ef2f4b57daac49cd2d4f0d702af50ae2c54f" }, "downloads": -1, "filename": "json-schema-for-humans-0.2.3.tar.gz", "has_sig": false, "md5_digest": "80624864198c58e4eda4dd9612a99532", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 19480, "upload_time": "2019-09-12T15:56:53", "url": "https://files.pythonhosted.org/packages/b6/35/aefc8cd73102fab2c01e4722f08000ec24d91e249f086a2c857fa8de1ad6/json-schema-for-humans-0.2.3.tar.gz" } ], "0.2.4": [ { "comment_text": "", "digests": { "md5": "63061e5b02d2de260f8b67ca96463eac", "sha256": "62dd4969e9813de44125254f75d7a18a03a40cf36b7ab6ce28fcc171109f6aa6" }, "downloads": -1, "filename": "json_schema_for_humans-0.2.4-py3-none-any.whl", "has_sig": false, "md5_digest": "63061e5b02d2de260f8b67ca96463eac", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 11420, "upload_time": "2019-09-13T00:09:56", "url": "https://files.pythonhosted.org/packages/6f/7b/d20682ff237485cf297609b35b77ed6aa95214928e6bc75354bad6e12c88/json_schema_for_humans-0.2.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "83634b4537de36c5422bc059d9f63fa3", "sha256": "6b2b3057381440a672b55e8153745c114c35f3d377530fff69199d35f35b07d1" }, "downloads": -1, "filename": "json-schema-for-humans-0.2.4.tar.gz", "has_sig": false, "md5_digest": "83634b4537de36c5422bc059d9f63fa3", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 20130, "upload_time": "2019-09-13T00:09:58", "url": "https://files.pythonhosted.org/packages/06/b4/a32f4b0423f05569a44ea376eb0fd6d28d47dbd7f158fe2cf42d7c159305/json-schema-for-humans-0.2.4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "63061e5b02d2de260f8b67ca96463eac", "sha256": "62dd4969e9813de44125254f75d7a18a03a40cf36b7ab6ce28fcc171109f6aa6" }, "downloads": -1, "filename": "json_schema_for_humans-0.2.4-py3-none-any.whl", "has_sig": false, "md5_digest": "63061e5b02d2de260f8b67ca96463eac", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 11420, "upload_time": "2019-09-13T00:09:56", "url": "https://files.pythonhosted.org/packages/6f/7b/d20682ff237485cf297609b35b77ed6aa95214928e6bc75354bad6e12c88/json_schema_for_humans-0.2.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "83634b4537de36c5422bc059d9f63fa3", "sha256": "6b2b3057381440a672b55e8153745c114c35f3d377530fff69199d35f35b07d1" }, "downloads": -1, "filename": "json-schema-for-humans-0.2.4.tar.gz", "has_sig": false, "md5_digest": "83634b4537de36c5422bc059d9f63fa3", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 20130, "upload_time": "2019-09-13T00:09:58", "url": "https://files.pythonhosted.org/packages/06/b4/a32f4b0423f05569a44ea376eb0fd6d28d47dbd7f158fe2cf42d7c159305/json-schema-for-humans-0.2.4.tar.gz" } ] }