{"id":13600786,"url":"https://github.com/yaegassy/coc-pydocstring","last_synced_at":"2025-04-13T06:06:09.658Z","repository":{"id":41488666,"uuid":"355154128","full_name":"yaegassy/coc-pydocstring","owner":"yaegassy","description":"doq (python docstring generator) extension for coc.nvim","archived":false,"fork":false,"pushed_at":"2023-08-08T01:50:14.000Z","size":223,"stargazers_count":30,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-13T06:04:51.273Z","etag":null,"topics":["coc","coc-extensions","coc-nvim","docstring","neovim","python","vim"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/coc-pydocstring","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yaegassy.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-04-06T10:52:01.000Z","updated_at":"2024-07-01T06:10:08.000Z","dependencies_parsed_at":"2024-10-14T18:40:59.300Z","dependency_job_id":"759eb837-5ef9-4ebb-9c4d-8d69d9b0ee8e","html_url":"https://github.com/yaegassy/coc-pydocstring","commit_stats":{"total_commits":81,"total_committers":1,"mean_commits":81.0,"dds":0.0,"last_synced_commit":"f199cea762f8d16545b7aaea7c888c87a318447e"},"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yaegassy%2Fcoc-pydocstring","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yaegassy%2Fcoc-pydocstring/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yaegassy%2Fcoc-pydocstring/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yaegassy%2Fcoc-pydocstring/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yaegassy","download_url":"https://codeload.github.com/yaegassy/coc-pydocstring/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248670437,"owners_count":21142904,"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":["coc","coc-extensions","coc-nvim","docstring","neovim","python","vim"],"created_at":"2024-08-01T18:00:48.569Z","updated_at":"2025-04-13T06:06:09.550Z","avatar_url":"https://github.com/yaegassy.png","language":"TypeScript","funding_links":[],"categories":["Language Support"],"sub_categories":[],"readme":"# coc-pydocstring\n\n[doq](https://pypi.org/project/doq/) (python docstring generator) extension for [coc.nvim](https://github.com/neoclide/coc.nvim)\n\n\u003cimg width=\"780\" alt=\"coc-pydocstring-demo\" src=\"https://user-images.githubusercontent.com/188642/113700321-aac1d500-9711-11eb-8564-bae852b93fa3.gif\"\u003e\n\n## Install\n\n**CocInstall**:\n\n```vim\n:CocInstall coc-pydocstring\n```\n\n**vim-plug**:\n\n```vim\nPlug 'yaegassy/coc-pydocstring', {'do': 'yarn install --frozen-lockfile'}\n```\n\n## Feature\n\nQuickly generate docstrings for python.\n\n- Code Action\n- Command\n- Built-in installer\n\n## Detect: \"doq\" command\n\n1. `pydocstring.doqPath` setting\n1. PATH environment (e.g. system global PATH or venv, etc ...)\n1. builtin: extension-only \"venv\" (Installation commands are also provided)\n\n## Built-in install\n\ncoc-pydocstring allows you to create an extension-only \"venv\" and install \"doq\".\n\nThe first time you use coc-pydocstring, if \"doq\" command is not detected, you will be prompted to do a built-in installation.\n\nYou can also run the installation command manually.\n\n```vim\n:CocCommand pydocstring.install\n```\n\n## Configuration options\n\n- `pydocstring.enable`: Enable coc-pydocstring extension, default: `true`\n- `pydocstring.doqPath`: The path to the doq tool (Absolute path), default: `\"\"`\n- `pydocstring.builtin.pythonPath`: Python 3.x path (Absolute path) to be used for built-in install, default: `\"\"`\n- `pydocstring.enableInstallPrompt`: Prompt the user before install, default: `true`\n- `pydocstring.formatter`: Docstring formatter (--formatter), valid options `[\"sphinx\", \"google\", \"numpy\"]`, default: `\"sphinx\"`\n- `pydocstring.templatePath`: Path to template directory (--template_path), Settings starting with `/` are recognized as `absolute path`, while others are treated as `relative path` from the `workspace root`. Additionally, both `~` and `$HOME` are also available and will be expanded as `absolute path`, default: `\"\"`\n- `pydocstring.ignoreException`: Ignore exception statements (--ignore_exception), default: `false`\n- `pydocstring.ignoreYield`: Ignore yield statements (--ignore_yield), default: `false`\n- `pydocstring.ignoreInit`: Ignore generate docstring to `__init__` method (--ignore_init). This option only available at `:CocCommand pydocstring.runFile`, default: `false`\n- `pydocstring.enableFileAction`: Enable file-level code action, default: `false`\n\n## Code Actions\n\n**Example key mapping (Code Action related)**:\n\n```vim\nnmap \u003csilent\u003e ga \u003cPlug\u003e(coc-codeaction-line)\nxmap \u003csilent\u003e ga \u003cPlug\u003e(coc-codeaction-selected)\nnmap \u003csilent\u003e gA \u003cPlug\u003e(coc-codeaction)\n```\n\n**Usage**:\n\nIn a \"line\" or \"selection\" containing `def`, `async def`, or `class`, enter the mapped key (e.g. `ga`) and display a list of code actions that can be performed.\n\n- `Add docstring for \"Line or Selected\" by pydocstring`\n- `Add docstring for \"File\" by pydocstring`\n  - File-level code actions are disabled (`false`) by default.\n  - If you want to use it, set `pydocstring.enableFileAction` to `true` in \"coc-settings.json\".\n\n## Commands\n\n- `pydocstring.runFile`: Run doq for file\n- `pydocstring.install`: Install doq\n  - It will be installed in this path:\n    - Mac/Linux: `~/.config/coc/extensions/coc-pydocstring-data/doq/venv/bin/doq`\n    - Windows: `~/AppData/Local/coc/extensions/coc-pydocstring-data/doq/venv/Scripts/doq.exe`\n- `pydocstring.showOutput`: Show pydocstring output channel\n\n## Similar plugins\n\n- [heavenshell/vim-pydocstring](https://github.com/heavenshell/vim-pydocstring)\n  - This is a vim plugin by the author of doq.\n\n## Thanks\n\n- [heavenshell/py-doq](https://github.com/heavenshell/py-doq) | [doq](https://pypi.org/project/doq/)\n\n## License\n\nMIT\n\n---\n\n\u003e This extension is built with [create-coc-extension](https://github.com/fannheyward/create-coc-extension)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyaegassy%2Fcoc-pydocstring","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyaegassy%2Fcoc-pydocstring","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyaegassy%2Fcoc-pydocstring/lists"}