{"id":27144,"library":"md-click-2","title":"MD-Click 2","description":"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.","status":"active","version":"0.0.1","language":"python","source_language":"en","source_url":"https://github.com/example/md-click-2","tags":["click","documentation","markdown","cli"],"install":[{"cmd":"pip install md-click-2","lang":"bash","label":"Install via pip"}],"dependencies":[],"imports":[{"note":"Library name uses hyphens, import uses underscores.","wrong":"from mdclick import MdClick","symbol":"MdClick","correct":"from md_click import MdClick"}],"quickstart":{"code":"from md_click import MdClick\nimport click\n\n@click.command()\ndef my_cli():\n    click.echo('Hello')\n\nif __name__ == '__main__':\n    MdClick(source_file='my_cli.py', output_dir='docs').generate()","lang":"python","description":"Generate markdown docs for a Click CLI."},"warnings":[{"fix":"Update imports and instantiate MdClick with source_file and output_dir.","message":"The API changed from md-click v1. The class is now `MdClick` with required arguments `source_file` and `output_dir`.","severity":"breaking","affected_versions":"0.0.1"},{"fix":"Use `from md_click import MdClick`.","message":"The 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`.","severity":"gotcha","affected_versions":"all"},{"fix":"Use `source_file='/path/to/your/cli.py'`.","message":"The `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.","severity":"gotcha","affected_versions":"all"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Use: `from md_click import MdClick`","cause":"Import typo: missing underscore.","error":"ModuleNotFoundError: No module named 'mdclick'"},{"fix":"Install md-click-2: `pip install md-click-2` and import: `from md_click import MdClick`","cause":"Old version or wrong library (md-click v1 has different class name).","error":"ImportError: cannot import name 'MdClick' from 'md_click'"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}