Generate Markdown documentation from a table schema file from Frictionless Data
Project description
Table Schema to Markdown
Create a Markdown documentation file from a Table Schema file.
The original code is coming from validata/validata-doc-generator.
Installation
pip install table-schema-to-markdown
Usage
Command line tool
The package provides a command line tool.
$ 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
Example:
table-schema-to-md schema.json documentation.md
In Python
from table_schema_to_markdown import convert_source
table_schema = '/tmp/schema.json'
out_file = open('/tmp/doc.md', 'a')
convert_source(table_schema, out_file)
Generated documentation example
Find a generated documentation file below.
Métadonnées d'un répertoire Git
- Auteur : Antoine Augusti antoine.augusti@example.com
- Schéma créé le : 12/31/18
- Site web : https://github.com/AntoineAugusti/data-codes-sources-fr
- Clé primaire :
repertoire_url
Modèle de données
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 uri ) |
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 |
Notice
This software is available under the MIT license.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for table_schema_to_markdown-0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c9ce0d7e68eb472cd44ecaf1b5504553eeaaba447312ed5409c040e0f4a0e441 |
|
MD5 | aa2829d3a85d1e03325be61210dd1adf |
|
BLAKE2b-256 | 5d26f3fbabbc30eb5be494c4824017c3374da4d6f17722d2fe3bffe3ec15fa72 |
Close
Hashes for table_schema_to_markdown-0.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e4dd4716bccca4fd3013d1f6f916b4e3586e9e8452cba2edd3532f1469b4a488 |
|
MD5 | 04d6ca5e5bff978e6ba9b6068ca30a63 |
|
BLAKE2b-256 | 2d1ede4e87e4ecb0efeff6f319d29f3719e50995e24c8e31373a5a60a57fe719 |