table-schema-to-markdown

v0.4.13

Generate Markdown documentation from a table schema file from Frictionless Data For more information about how to use this package see README

Latest version published 1 month ago

License: MIT

PyPI

GitHub

Package Health Score

66 / 100

security
No known security issues
popularity
Limited
maintenance
Healthy
community
Limited

Popularity

Limited

GitHub Stars: 4
Forks: 2
Contributors: 4

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package table-schema-to-markdown, we found that it has been starred 4 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Oct 7, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like table-schema-to-markdown is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Healthy

Commit Frequency

Open Issues: 0
Open PR: 0
Last Release: 1 month ago
Last Commit: 1 month ago

Further analysis of the maintenance status of table-schema-to-markdown based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that table-schema-to-markdown demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Limited

Readme: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 4
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like table-schema-to-markdown is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: <4,>=3

Age: 6 years
Latest Release: 1 month ago
Dependencies: 0 Direct
Versions: 19
Maintainers: 3
Wheels: OS Independent

Readme

CircleCI PyPI PyPI Python version

Table Schema to Markdown

Create a Markdown documentation file from a Table Schema file.

The original scripts are coming from doc-generator for the Validata project, which are now available as an npm package.

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:

# Print generated Markdown
table-schema-to-md schema.json
# Save to Markdown file
table-schema-to-md schema.json -o documentation.md

In Python

from table_schema_to_markdown import convert_source

# Generate a Markdown documentation from a JSON file
table_schema = '/tmp/schema.json'
with open('/tmp/doc.md', 'a') as out:
    convert_source(table_schema, out)

# Generate Markdown documentation in a string
import io

with io.StringIO() as buff:
    convert_source(table_schema, buff)
    documentation = buff.getvalue()

Generated documentation example

This table schema file is rendered in Markdown in this file.

Find a generated documentation file below.

Métadonnées d'un répertoire Git

Auteur : Antoine Augusti
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.

FAQs

What is table-schema-to-markdown?

Generate Markdown documentation from a table schema file from Frictionless Data. Visit Snyk Advisor to see a full health score report for table-schema-to-markdown, including popularity, security, maintenance & community analysis.

Is table-schema-to-markdown popular?

The python package table-schema-to-markdown receives a total of 214 weekly downloads. As such, table-schema-to-markdown popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is table-schema-to-markdown well maintained?

We found that table-schema-to-markdown demonstrated a healthy version release cadence and project activity. It has a community of 4 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is table-schema-to-markdown safe to use?

The python package table-schema-to-markdown was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 10 November-2024, at 21:46 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP