Package Health Score

75 / 100

security
No known security issues
popularity
Small
maintenance
Healthy
community
Sustainable

Explore Similar Packages

pydantic
97

Popularity

Small

GitHub Stars: 21
Forks: 13
Contributors: 20

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package jsonschema2md, we found that it has been starred 21 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Aug 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

Apache-2.0

Security Policy

We found a way for you to contribute to the project! Looks like jsonschema2md 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: 9
Open PR: 1
Last Release: 3 months ago
Last Commit: 13 days ago

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

We found that jsonschema2md 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

Sustainable

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

With more than 10 contributors for the jsonschema2md repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like jsonschema2md 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: >=3.9

Age: 4 years
Latest Release: 3 months ago
Dependencies: 0 Direct
Versions: 11
Maintainers: 2
Wheels: OS Independent

Readme

jsonschema2md

Convert JSON Schemas to simple, human-readable Markdown documentation.

For example:

{
  "$id": "https://example.com/person.schema.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Person",
  "description": "JSON Schema for a person object.",
  "type": "object",
  "properties": {
    "firstName": {
      "type": "string",
      "description": "The person's first name."
    },
    "lastName": {
      "type": "string",
      "description": "The person's last name."
    }
  }
}

will be converted to:

> # Person > > JSON Schema for a person object. > > ## Properties > > - firstName (string): The person's first name. > - lastName (string): The person's last name.

See the examples directory for more elaborate examples.

Installation

Install with pip

pip install jsonschema2md

Usage

From the CLI

jsonschema2md [OPTIONS]

From Python

import json
import jsonschema2md

parser = jsonschema2md.Parser(
    examples_as_yaml=False,
    show_examples="all",
)
with open("./examples/food.json", "r") as json_file:
    md_lines = parser.parse_schema(json.load(json_file))
print(''.join(md_lines))

Options

examples-as-yaml: Parse examples in YAML-format instead of JSON. (bool, default: False)
show-examples: Parse examples for only the main object, only properties, or all. (str, default all, options: object, properties, all)

pre-commit hook

You can use the pre-commit hook with:

repos:
  - repo: https://github.com/sbrunner/jsonschema2md
    rev:  # Use the ref you want to point at
    hooks:
      - id: jsonschema2md
        files: schema.json
        args:
          - --pre-commit
          - schema.json
          - schema.md

Contributing

Bugs, questions or suggestions? Feel free to post an issue in the issue tracker or to make a pull request! See Contributing.md for more info.

Install the pre-commit hooks:

pip install pre-commit
pre-commit install --allow-missing-config

Changelog

See Changelog.md.

FAQs

What is jsonschema2md?

Convert JSON Schema to human-readable Markdown documentation. Visit Snyk Advisor to see a full health score report for jsonschema2md, including popularity, security, maintenance & community analysis.

Is jsonschema2md popular?

The python package jsonschema2md receives a total of 6,266 weekly downloads. As such, jsonschema2md popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is jsonschema2md well maintained?

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

Is jsonschema2md safe to use?

The python package jsonschema2md 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 15 November-2024, at 12:34 (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

jsonschema2md

Convert JSON Schema to human-readable Markdown documentation For more information about how to use this package see README

Ensure you're using the healthiest python packages

Package Health Score

Explore Similar Packages

Popularity

Direct Usage Popularity

Security

Security and license risk for latest version

Maintenance

Commit Frequency

Community

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Package

Readme

jsonschema2md

Installation

Usage

From the CLI

From Python

Options

pre-commit hook

Contributing

Changelog

FAQs

What is jsonschema2md?

Is jsonschema2md popular?

Is jsonschema2md well maintained?

Is jsonschema2md safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Explore Similar Packages

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Readme

jsonschema2md

Installation

Usage

From the CLI

From Python

Options

pre-commit hook

Contributing

Changelog

FAQs

What is jsonschema2md?

Is jsonschema2md popular?

Is jsonschema2md well maintained?

Is jsonschema2md safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues