sphinx-argparse-cli

v1.16.0

render CLI arguments (sub-commands friendly) defined by argparse module For more information about how to use this package see README

Latest version published 1 month ago

License: MIT

PyPI

GitHub

Package Health Score

75 / 100

security
No known security issues
popularity
Small
maintenance
Healthy
community
Sustainable

Popularity

Small

GitHub Stars: 20
Forks: 9
Contributors: 10

Direct Usage Popularity

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

Security

No known security issues

Security and license risk for latest version

Release Date: Jun 18, 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

Yes

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: 5
Open PR: 1
Last Release: 1 month ago
Last Commit: 1 month ago

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

We found that sphinx-argparse-cli 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: No
Code of Conduct: Yes
Contributors: 10
Funding: Yes

This project has seen only 10 or less contributors.

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: 3 years
Latest Release: 1 month ago
Dependencies: 0 Direct
Versions: 24
Maintainers: 2
Wheels: OS Independent

Readme

sphinx-argparse-cli

check

Render CLI arguments (sub-commands friendly) defined by the argparse module. For live demo checkout the documentation of tox, pypa-build and mdpo.

installation

python -m pip install sphinx-argparse-cli

enable in your `conf.py`

# just add it to your list of extensions to load within conf.py
extensions = ["sphinx_argparse_cli"]

use

Within the reStructuredText files use the sphinx_argparse_cli directive that takes, at least, two arguments:

Name	Description
module	the module path to where the parser is defined
func	the name of the function that once called with no arguments constructs the parser
prog	(optional) when provided, overwrites the `` name.
hook	(optional) hook `argparse` to retrieve the parser if `func` uses a parser instead of returning it.
title	(optional) when provided, overwrites the `- CLI interface` title added by default and when empty, will not be included
description	(optional) when provided, overwrites the description and when empty, will not be included
epilog	(optional) when provided, overwrites the epilog and when empty, will not be included
usage_width	(optional) how large should usage examples be - defaults to 100 character
usage_first	(optional) show usage before description
group_title_prefix	(optional) groups subsections title prefixes, accepts the string `{prog}` as a replacement for the program name - defaults to `{prog}`
group_sub_title_prefix	(optional) subcommands groups subsections title prefixes, accepts replacement of `{prog}` and `{subcommand}` for program and subcommand name - defaults to `{prog} {subcommand}`
no_default_values	(optional) suppresses generation of `default` entries

For example:

.. sphinx_argparse_cli::
  :module: a_project.cli
  :func: build_parser
  :prog: my-cli-program

If you have code that creates and uses a parser but does not return it, you can specify the :hook: flag:

.. sphinx_argparse_cli::
  :module: a_project.cli
  :func: main
  :hook:
  :prog: my-cli-program

Refer to generated content

The tool will register reference links to all anchors. This means that you can use the sphinx ref role to refer to both the (sub)command title/groups and every flag/argument. The tool offers a configuration flag sphinx_argparse_cli_prefix_document (change by setting this variable in conf.py - by default False). This option influences the reference ids generated. If it's false the reference will be the anchor id (the text appearing after the '# in the URI once you click on it). If it's true the anchor id will be prefixed by the document name (this is useful to avoid reference label clash when the same anchors are generated in multiple documents).

For example in case of a tox command, and sphinx_argparse_cli_prefix_document=False (default):

to refer to the optional arguments group use :ref:`tox-optional-arguments` ,
to refer to the run subcommand use :ref:`tox-run` ,
to refer to flag --magic of the run sub-command use :ref:`tox-run---magic` .

For example in case of a tox command, and sphinx_argparse_cli_prefix_document=True, and the current document name being cli:

to refer to the optional arguments group use :ref:`cli:tox-optional-arguments` ,
to refer to the run subcommand use :ref:`cli:tox-run` ,
to refer to flag --magic of the run sub-command use :ref:`cli:tox-run---magic` .

FAQs

What is sphinx-argparse-cli?

render CLI arguments (sub-commands friendly) defined by argparse module. Visit Snyk Advisor to see a full health score report for sphinx-argparse-cli, including popularity, security, maintenance & community analysis.

Is sphinx-argparse-cli popular?

The python package sphinx-argparse-cli receives a total of 5,115 weekly downloads. As such, sphinx-argparse-cli popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is sphinx-argparse-cli well maintained?

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

Is sphinx-argparse-cli safe to use?

The python package sphinx-argparse-cli 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 23 July-2024, at 09:11 (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

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-argparse-cli

installation

enable in your conf.py

use

Refer to generated content

FAQs

What is sphinx-argparse-cli?

Is sphinx-argparse-cli popular?

Is sphinx-argparse-cli well maintained?

Is sphinx-argparse-cli 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

enable in your `conf.py`