Package Health Score

71 / 100

security
No known security issues
popularity
Recognized
maintenance
Inactive
community
Active

Popularity

Recognized

GitHub Stars: 213
Forks: 57
Contributors: 30

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package sphinx-click, we found that it has been starred 213 times.

Security

No known security issues

Security and license risk for latest version

Release Date: May 15, 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 sphinx-click 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

Inactive

Commit Frequency

Open Issues: 12
Open PR: 3
Last Release: 7 months ago
Last Commit: 7 months ago

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

We found that sphinx-click demonstrates a positive version release cadence with at least one new version released in the past 12 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

Active

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

With more than 10 contributors for the sphinx-click 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 sphinx-click 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.8

Age: 8 years
Latest Release: 7 months ago
Dependencies: 1 Direct
Versions: 43
Maintainers: 1
Wheels: OS Independent

Readme

sphinx-click

sphinx-click is a Sphinx plugin that allows you to automatically extract documentation from a Click-based application and include it in your docs.

Installation

Install the plugin using pip:

$ pip install sphinx-click

Alternatively, install from source by cloning this repo then running pip locally:

$ pip install .

Usage

Important

To document a Click-based application, both the application itself and any additional dependencies required by that application must be installed.

Enable the plugin in your Sphinx conf.py file:

extensions = ['sphinx_click']

Once enabled, you can now use the plugin wherever necessary in the documentation.

.. click:: module:parser
   :prog: hello-world
   :nested: full

Detailed information on the various options available is provided in the documentation.

Alternative

This plugin is perfect to document a Click-based CLI in Sphinx, as it properly renders the help screen and its options in nice HTML with deep links and styling.

However, if you are looking to document the source code of a Click-based CLI, and the result of its execution, you might want to check out click-extra. The latter provides the .. click:example:: and .. click:run:: Sphinx directives so you can capture and render, with full colors, the result of your CLI in your documentation.

sphinx-click dependencies

docutils

FAQs

What is sphinx-click?

Sphinx extension that automatically documents click applications. Visit Snyk Advisor to see a full health score report for sphinx-click, including popularity, security, maintenance & community analysis.

Is sphinx-click popular?

The python package sphinx-click receives a total of 76,415 weekly downloads. As such, sphinx-click popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is sphinx-click well maintained?

We found indications that sphinx-click is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is sphinx-click safe to use?

The python package sphinx-click 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 21 December-2024, at 08:08 (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

sphinx-click

Sphinx extension that automatically documents click applications For more information about how to use this package see README

Ensure you're using the healthiest python packages

Package Health Score

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

sphinx-click

Installation

Usage

Alternative

sphinx-click dependencies

FAQs

What is sphinx-click?

Is sphinx-click popular?

Is sphinx-click well maintained?

Is sphinx-click 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

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

sphinx-click

Installation

Usage

Alternative

sphinx-click dependencies

FAQs

What is sphinx-click?

Is sphinx-click popular?

Is sphinx-click well maintained?

Is sphinx-click 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