md-click-2

library0.0.1pypypi✓ verified 80d ago

A command line tool for automatically generating .md markdown files from Click-based CLI commands. Based on a fork, version 0.0.1 with weekly releases and Python >=3.8 support.

devops

pip install md-click-2

package ↗

INSTALL

IMPORT

SIG · MD-CLICK-2

md-click-2

devopspythonv0.0.1

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

cli

✓ from md_click import cli

✗ from md_click import MdClick

main

✓ from md_click import main

✗ from md_click import MdClick

Generate markdown docs for a Click CLI.

from md_click import MdClick import click @click.command() def my_cli(): click.echo('Hello') if __name__ == '__main__': MdClick(source_file='my_cli.py', output_dir='docs').generate()

md-click-2 --version

Debug

Known issues

breakingThe API changed from md-click v1. The class is now `MdClick` with required arguments `source_file` and `output_dir`.

fix

Update imports and instantiate MdClick with source_file and output_dir.

affects: 0.0.1

gotchaThe library name uses a hyphen but Python import uses an underscore. Common mistake: `import md_click_2` (wrong) instead of `from md_click import MdClick`.

fix

Use `from md_click import MdClick`.

affects: all

gotchaThe `source_file` must be a path to a Python file that defines Click commands. If the file is not in the current directory, provide an absolute or relative path.

fix

Use `source_file='/path/to/your/cli.py'`.

affects: all

Upgrade

Version history

0.0.1latest on PyPI · released Feb 6, 2025

Audit

Dependencies

No dependency data recorded yet.

Agent activity

2 hits · last 30 days

node

Resources

packagehttps://pypi.org/project/md-click-2/ ↗