从无摩擦数据的表架构文件生成标记文档
table-schema-to-markdown的Python项目详细描述
要标记的表架构
从Table Schema file创建标记文档文件。
原始代码来自validata/validata-doc-generator。
安装
pip install table-schema-to-markdown
用法
命令行工具
这个包提供了一个命令行工具。
$ table-schema-to-md -h
usage: table-schema-to-md [-h] [-o OUTPUT] [--log LOG] table_schema
positional arguments:
table_schema path or URL of table schema file
optional arguments:
-h, --help show this help message and exit
-o OUTPUT, --output OUTPUT
Output file name
--log LOG level of logging messages
示例：
# Print generated Markdown table-schema-to-md schema.json # Save to Markdown file table-schema-to-md schema.json -o documentation.md
在python中
fromtable_schema_to_markdownimportconvert_source# Generate a Markdown documentation from a JSON filetable_schema='/tmp/schema.json'withopen('/tmp/doc.md','a')asout:convert_source(table_schema,out)# Generate Markdown documentation in a stringimportiowithio.StringIO()asbuff:convert_source(table_schema,buff)documentation=buff.getvalue()
生成的文档示例
This table schema file在this file中以降价方式呈现。
在下面找到生成的文档文件。
梅塔多内斯d'un répertoire git酒店
- 导演：安托万·奥古斯蒂antoine.augusti@example.com
- Schéma Créle:18年12月31日
- 网站：https://github.com/AntoineAugusti/data-codes-sources-fr
- 初生火焰：
repertoire_url
多涅斯模式
| Nom | Type | Description | Exemple | Propriétés |
|---|---|---|---|---|
| nom | chaîne de caractères | Le nom du répertoire | nom-repertoire | Valeur obligatoire |
| organisation_nom | chaîne de caractères | Le nom de l'organisation | etalab | Valeur obligatoire |
| plateforme | chaîne de caractères | La plateforme de dépôt de code | GitHub | Valeur obligatoire, Valeurs autorisées : GitHub |
| repertoire_url | chaîne de caractères (format ^{ | L'URL vers le répertoire | https://github.com/etalab/nom-repertoire | Valeur obligatoire |
| description | chaîne de caractères | La description du répertoire | Ce répertoire est utile | Valeur optionnelle |
| est_fork | booléen | Indique si le répertoire est un fork | false | Valeur obligatoire |
| date_creation | date et heure | La date de création du répertoire | 2018-12-01T20:00:55Z | Valeur obligatoire |
| derniere_mise_a_jour | date et heure | La date de dernière mise à jour du répertoire | 2018-12-01T20:00:55Z | Valeur obligatoire |
| page_accueil | chaîne de caractères | URL vers la page d'accueil du projet | https://etalab.gouv.fr | Valeur optionnelle |
| nombre_stars | nombre entier | Le nombre de fois où le répertoire a été ajouté aux favoris | 42 | Valeur obligatoire, Valeur minimale : 0 |
| nombre_forks | nombre entier | Le nombre de fois où le répertoire a été forké | 13 | Valeur obligatoire, Valeur minimale : 0 |
| licence | chaîne de caractères | La licence du répertoire, telle que détectée par la plateforme | MIT | Valeur optionnelle |
| nombre_issues_ouvertes | nombre entier | Le nombre d'issues actuellement ouvertes | 0 | Valeur obligatoire, Valeur minimale : 0 |
| langage | chaîne de caractères | Le langage principal du répertoire, tel que détecté par la plateforme | Python | Valeur optionnelle |
| topics | chaîne de caractères | Les tags du répertoire | utile,france,opendata | Valeur optionnelle |
注意
这个软件是在麻省理工学院的许可下提供的。
欢迎加入QQ群-->： 979659372
