{"id":15048778,"url":"https://github.com/riveryio/md-click","last_synced_at":"2025-04-10T01:33:54.063Z","repository":{"id":45525706,"uuid":"347138335","full_name":"RiveryIO/md-click","owner":"RiveryIO","description":"MD-Click is a command line tool for creating `.md` files for any python's click CLI projects","archived":false,"fork":false,"pushed_at":"2024-05-17T11:40:53.000Z","size":306,"stargazers_count":12,"open_issues_count":6,"forks_count":13,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-08T10:53:53.634Z","etag":null,"topics":["cli","click","markdown","md","mkdocs","python-click","python3"],"latest_commit_sha":null,"homepage":"https://riveryio.github.io/md-click/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RiveryIO.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-03-12T17:03:05.000Z","updated_at":"2025-02-01T18:57:50.000Z","dependencies_parsed_at":"2025-02-16T08:45:26.596Z","dependency_job_id":null,"html_url":"https://github.com/RiveryIO/md-click","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RiveryIO%2Fmd-click","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RiveryIO%2Fmd-click/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RiveryIO%2Fmd-click/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RiveryIO%2Fmd-click/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RiveryIO","download_url":"https://codeload.github.com/RiveryIO/md-click/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248140873,"owners_count":21054363,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","click","markdown","md","mkdocs","python-click","python3"],"created_at":"2024-09-24T21:16:09.979Z","updated_at":"2025-04-10T01:33:54.054Z","avatar_url":"https://github.com/RiveryIO.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MD Click\nMD-Click is a command line tool for creating `.md` files for any python's click CLI projects.\n\n# The Problem\nAfter creating new CLI project using click, we couldn't found out any tool that generates automatic\n`.md` files documentation per each command. This is the reason we've create this quick and easy tool.\n\n# The Solution\nMD-Click creates `.md` files per each command exists under the `click` project CLI.\nThe tool runs recursively and generates a markdown file per each command, and sub commands.\n\n# Installation\n\nJust install it using pip:\n```bash\n\u003e pip install md-click\n```\n\n# Usage\n\nCreate md files per each command, in format of `parent-command`, under the `--docsPath` directory.\n\nfor example, we have the next click python module:\n\n```python\n# app/cli.py\nimport click\n\n@click.group('namer')\n@click.option('--debug', help='Should I run on Debug?', is_flag=True)\ndef main(**kwargs):\n  \"\"\" A namer CLI \"\"\"\n  debug = kwargs.get('debug')\n  if debug:\n    click.secho('is Debug? True', color='green')\n\n@main.command('full')\n@click.option('--name', help='The user name', required=True, type=str)\n@click.option('--lastName', help='The last Name', required=False, type=str)\ndef full_name(**kwargs):\n    \"\"\" A CLI that gets name and last name and returns the full name\"\"\"\n    firstname = kwargs.get('name')\n    lastname = kwargs.get('lastname')\n    \n    click.secho(f'The full name is: {firstname} {lastname}', color='yellow')\n```\n\nand we want to create a nice md files per each command, we'll run the next cli command:\n\n```shell\n\u003e mdclick dumps --baseModule=app.cli --baseCommand=main --docPath=./docs/commands\n```\n\nThe output:\n\n```shell\n./docs/commands/namer.md\n./docs/commands/namer-full.md\n```\n\nAs you can assume, all of the markdown files under `docs/commands` in this repository, generated automatically by `mdclick` command.\nUse them as a reference.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Friveryio%2Fmd-click","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Friveryio%2Fmd-click","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Friveryio%2Fmd-click/lists"}