{ "info": { "author": "Antoine Augusti", "author_email": "hi@antoine-augusti.fr", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "[![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/AntoineAugusti/table-schema-to-markdown/blob/master/LICENSE.md)\n![CircleCI](https://img.shields.io/circleci/project/github/AntoineAugusti/table-schema-to-markdown.svg?style=flat-square)\n![PyPI](https://img.shields.io/pypi/v/table-schema-to-markdown.svg?style=flat-square)\n![PyPI Python version](https://img.shields.io/pypi/pyversions/table-schema-to-markdown.svg?style=flat-square)\n\n# Table Schema to Markdown\nCreate a Markdown documentation file from a [Table Schema file](https://frictionlessdata.io/specs/table-schema/).\n\nThe original code is coming from [validata/validata-doc-generator](https://git.opendatafrance.net/validata/validata-doc-generator).\n\n## Installation\n```\npip install table-schema-to-markdown\n```\n\n## Usage\n### Command line tool\nThe package provides a command line tool.\n```\n$ table-schema-to-md -h\nusage: table-schema-to-md [-h] [-o OUTPUT] [--log LOG] table_schema\n\npositional arguments:\n table_schema path or URL of table schema file\n\noptional arguments:\n -h, --help show this help message and exit\n -o OUTPUT, --output OUTPUT\n Output file name\n --log LOG level of logging messages\n```\n\nExample:\n```sh\n# Print generated Markdown\ntable-schema-to-md schema.json\n# Save to Markdown file\ntable-schema-to-md schema.json -o documentation.md\n```\n\n### In Python\n```python\nfrom table_schema_to_markdown import convert_source\n\n# Generate a Markdown documentation from a JSON file\ntable_schema = '/tmp/schema.json'\nwith open('/tmp/doc.md', 'a') as out:\n convert_source(table_schema, out)\n\n# Generate Markdown documentation in a string\nimport io\n\nwith io.StringIO() as buff:\n convert_source(table_schema, buff)\n documentation = buff.getvalue()\n```\n\n## Generated documentation example\n[This table schema file](tests/files/repertoire.json) is rendered in Markdown in [this file](tests/files/expected_repertoire.md).\n\nFind a generated documentation file below.\n\n## M\u00e9tadonn\u00e9es d'un r\u00e9pertoire Git\n\n- Auteur : Antoine Augusti \n- Sch\u00e9ma cr\u00e9\u00e9 le : 12/31/18\n- Site web : https://github.com/AntoineAugusti/data-codes-sources-fr\n- Cl\u00e9 primaire\u00a0: `repertoire_url`\n\n### Mod\u00e8le de donn\u00e9es\n\n|Nom|Type|Description|Exemple|Propri\u00e9t\u00e9s|\n|-|-|-|-|-|\n|nom|cha\u00eene de caract\u00e8res|Le nom du r\u00e9pertoire|nom-repertoire|Valeur obligatoire|\n|organisation_nom|cha\u00eene de caract\u00e8res|Le nom de l'organisation|etalab|Valeur obligatoire|\n|plateforme|cha\u00eene de caract\u00e8res|La plateforme de d\u00e9p\u00f4t de code|GitHub|Valeur obligatoire, Valeurs autoris\u00e9es\u00a0: GitHub|\n|repertoire_url|cha\u00eene de caract\u00e8res (format `uri`)|L'URL vers le r\u00e9pertoire|https://github.com/etalab/nom-repertoire|Valeur obligatoire|\n|description|cha\u00eene de caract\u00e8res|La description du r\u00e9pertoire|Ce r\u00e9pertoire est utile|Valeur optionnelle|\n|est_fork|bool\u00e9en|Indique si le r\u00e9pertoire est un fork|false|Valeur obligatoire|\n|date_creation|date et heure|La date de cr\u00e9ation du r\u00e9pertoire|2018-12-01T20:00:55Z|Valeur obligatoire|\n|derniere_mise_a_jour|date et heure|La date de derni\u00e8re mise \u00e0 jour du r\u00e9pertoire|2018-12-01T20:00:55Z|Valeur obligatoire|\n|page_accueil|cha\u00eene de caract\u00e8res|URL vers la page d'accueil du projet|https://etalab.gouv.fr|Valeur optionnelle|\n|nombre_stars|nombre entier|Le nombre de fois o\u00f9 le r\u00e9pertoire a \u00e9t\u00e9 ajout\u00e9 aux favoris|42|Valeur obligatoire, Valeur minimale\u00a0: 0|\n|nombre_forks|nombre entier|Le nombre de fois o\u00f9 le r\u00e9pertoire a \u00e9t\u00e9 fork\u00e9|13|Valeur obligatoire, Valeur minimale\u00a0: 0|\n|licence|cha\u00eene de caract\u00e8res|La licence du r\u00e9pertoire, telle que d\u00e9tect\u00e9e par la plateforme|MIT|Valeur optionnelle|\n|nombre_issues_ouvertes|nombre entier|Le nombre d'issues actuellement ouvertes|0|Valeur obligatoire, Valeur minimale\u00a0: 0|\n|langage|cha\u00eene de caract\u00e8res|Le langage principal du r\u00e9pertoire, tel que d\u00e9tect\u00e9 par la plateforme|Python|Valeur optionnelle|\n|topics|cha\u00eene de caract\u00e8res|Les tags du r\u00e9pertoire|utile,france,opendata|Valeur optionnelle|\n\n## Notice\nThis software is available under the MIT license.", "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/AntoineAugusti/table_schema_to_markdown", "keywords": "frictionlessdata,documentation,tableschema,table-schema,frictionless data,open data,json schema,json table schema,data package,tabular data package", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "table-schema-to-markdown", "package_url": "https://pypi.org/project/table-schema-to-markdown/", "platform": "", "project_url": "https://pypi.org/project/table-schema-to-markdown/", "project_urls": { "Homepage": "https://github.com/AntoineAugusti/table_schema_to_markdown" }, "release_url": "https://pypi.org/project/table-schema-to-markdown/0.3.1/", "requires_dist": null, "requires_python": ">=3, <4", "summary": "Generate Markdown documentation from a table schema file from Frictionless Data", "version": "0.3.1" }, "last_serial": 5149847, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "04d6ca5e5bff978e6ba9b6068ca30a63", "sha256": "e4dd4716bccca4fd3013d1f6f916b4e3586e9e8452cba2edd3532f1469b4a488" }, "downloads": -1, "filename": "table_schema_to_markdown-0.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "04d6ca5e5bff978e6ba9b6068ca30a63", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=3, <4", "size": 7003, "upload_time": "2019-01-22T10:01:37", "url": "https://files.pythonhosted.org/packages/2d/1e/de4e87e4ecb0efeff6f319d29f3719e50995e24c8e31373a5a60a57fe719/table_schema_to_markdown-0.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "aa2829d3a85d1e03325be61210dd1adf", "sha256": "c9ce0d7e68eb472cd44ecaf1b5504553eeaaba447312ed5409c040e0f4a0e441" }, "downloads": -1, "filename": "table_schema_to_markdown-0.1.tar.gz", "has_sig": false, "md5_digest": "aa2829d3a85d1e03325be61210dd1adf", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3, <4", "size": 5659, "upload_time": "2019-01-22T10:01:39", "url": "https://files.pythonhosted.org/packages/5d/26/f3fbabbc30eb5be494c4824017c3374da4d6f17722d2fe3bffe3ec15fa72/table_schema_to_markdown-0.1.tar.gz" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "4ab70b075ffd90ede043663fff0e9958", "sha256": "914ee993b9cb47a767e139755999fbea124899bf2bdfac62116d369ec8e8055d" }, "downloads": -1, "filename": "table_schema_to_markdown-0.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "4ab70b075ffd90ede043663fff0e9958", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=3, <4", "size": 7131, "upload_time": "2019-01-28T09:43:04", "url": "https://files.pythonhosted.org/packages/69/b4/bb5b4df71924dc43cf3f37705167e78cd64da2087222fb2fdfb312d05768/table_schema_to_markdown-0.2-py2.py3-none-any.whl" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "c0e8bb7ed61c5d1d6ae7d6a557f0d411", "sha256": "5f23ac1a80c7719aa7cd4c04d331907713ec825989f4ec39007bf84243d08ba6" }, "downloads": -1, "filename": "table_schema_to_markdown-0.2.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "c0e8bb7ed61c5d1d6ae7d6a557f0d411", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=3, <4", "size": 7167, "upload_time": "2019-01-28T15:46:14", "url": "https://files.pythonhosted.org/packages/81/12/72de06e3c2374ca8aba8c23ce16249166e4b4974ac2b814970dc003ccda3/table_schema_to_markdown-0.2.1-py2.py3-none-any.whl" } ], "0.3": [ { "comment_text": "", "digests": { "md5": "e30abd49726cd4353f1fe48aec6ed7a3", "sha256": "a5c6231804d9bf76929770c062b192acad928d4ec2b64bd2dbe31e6bd9bd7f8b" }, "downloads": -1, "filename": "table_schema_to_markdown-0.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "e30abd49726cd4353f1fe48aec6ed7a3", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=3, <4", "size": 7311, "upload_time": "2019-03-23T20:07:26", "url": "https://files.pythonhosted.org/packages/40/85/0900dcbe31c3af67561a11dce8c211332e7b32d396c491c0e848dc1d9b54/table_schema_to_markdown-0.3-py2.py3-none-any.whl" } ], "0.3.1": [ { "comment_text": "", "digests": { "md5": "294e817a8392edea60d41945c05b0ba6", "sha256": "efff11148314a6fdd4276e62c8d0fed4d88be0739ff721f79b183a1860dace7b" }, "downloads": -1, "filename": "table_schema_to_markdown-0.3.1.tar.gz", "has_sig": false, "md5_digest": "294e817a8392edea60d41945c05b0ba6", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3, <4", "size": 5994, "upload_time": "2019-04-16T12:36:54", "url": "https://files.pythonhosted.org/packages/bf/6b/e5535cb13c88259fc94b541abf8e51a87895867cebf7d8ff3dfb9e723b25/table_schema_to_markdown-0.3.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "294e817a8392edea60d41945c05b0ba6", "sha256": "efff11148314a6fdd4276e62c8d0fed4d88be0739ff721f79b183a1860dace7b" }, "downloads": -1, "filename": "table_schema_to_markdown-0.3.1.tar.gz", "has_sig": false, "md5_digest": "294e817a8392edea60d41945c05b0ba6", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3, <4", "size": 5994, "upload_time": "2019-04-16T12:36:54", "url": "https://files.pythonhosted.org/packages/bf/6b/e5535cb13c88259fc94b541abf8e51a87895867cebf7d8ff3dfb9e723b25/table_schema_to_markdown-0.3.1.tar.gz" } ] }