{"id":21391905,"url":"https://github.com/mannasoumya/py-docstring-generator","last_synced_at":"2025-03-16T13:26:09.010Z","repository":{"id":57845302,"uuid":"528061351","full_name":"mannasoumya/py-docstring-generator","owner":"mannasoumya","description":"Auto Generate Python Docstrings","archived":false,"fork":false,"pushed_at":"2022-11-22T09:49:53.000Z","size":23,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-23T01:13:43.146Z","etag":null,"topics":["docs-generator","docstring","docstring-generator","docstrings","documentation","python","python3"],"latest_commit_sha":null,"homepage":"","language":"Python","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/mannasoumya.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}},"created_at":"2022-08-23T15:51:41.000Z","updated_at":"2022-08-24T11:57:23.000Z","dependencies_parsed_at":"2023-01-23T16:15:53.584Z","dependency_job_id":null,"html_url":"https://github.com/mannasoumya/py-docstring-generator","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/mannasoumya%2Fpy-docstring-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mannasoumya%2Fpy-docstring-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mannasoumya%2Fpy-docstring-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mannasoumya%2Fpy-docstring-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mannasoumya","download_url":"https://codeload.github.com/mannasoumya/py-docstring-generator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243873931,"owners_count":20361727,"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":["docs-generator","docstring","docstring-generator","docstrings","documentation","python","python3"],"created_at":"2024-11-22T13:38:18.960Z","updated_at":"2025-03-16T13:26:08.985Z","avatar_url":"https://github.com/mannasoumya.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Auto Generate Python Docstrings \n\n## Quick Start\n\n```console\n$ python3 docstring_generator_auto.py test.py\n\nFunction `hello1`\nParams ['a:str', 'b:list', 'c']\nDo you want to write docstring for `hello1` ? (y/n)  y\nEnter function summary:  This is first hello\nAre you sure? (y/n)  y\n\na : str\nEnter parameter summary:  first param\nAre you sure? (y/n)  y\n\nb : list\nEnter parameter summary:  second param\nAre you sure? (y/n)  y\n\nc : \nEnter parameter summary:  third param\nAre you sure? (y/n)  y\n\n\nNo explicit return type found for function `hello1`\nEnter return summary:  Returns None\nAre you sure? (y/n)  y\n\nFunction `hello2`\nParams ['a:tuple']\nDo you want to write docstring for `hello2` ? (y/n)  y\nEnter function summary:  This is second hello\nAre you sure? (y/n)  y\n\na : tuple\nEnter parameter summary:  tuple param\nAre you sure? (y/n)  y\n\n\nNo explicit return type found for function `hello2`\nEnter return summary:  Returns None\nAre you sure? (y/n)  y\n\nFunction `hello3` has no parameters\nDo you want to write docstring for `hello3` ? (y/n)  y\nEnter function summary:  This is third hello\nAre you sure? (y/n)  y\n\nReturn type of function `hello3` is `str`\nEnter return summary:  Returns hello3\nAre you sure? (y/n)  y\n\nNew file with docstings saved at : `test_docstrings.py`\n```\n\n#### When all docstrings are added, skip all functions\n```console\n$ python3 docstring_generator_auto.py test.py\n\nFunction `hello1`\nParams ['a:str', 'b:list', 'c']\nDo you want to write docstring for `hello1` ? (y/n)  n\n\nFunction `hello2`\nParams ['a:tuple']\nDo you want to write docstring for `hello2` ? (y/n)  n\n\nFunction `hello3` has no parameters\nDo you want to write docstring for `hello3` ? (y/n)  n\n\nNo docstrings to save... Exiting\n```\n **New file with docstring is generated at \u003cfile-path_docstrings.py\u003e** ","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmannasoumya%2Fpy-docstring-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmannasoumya%2Fpy-docstring-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmannasoumya%2Fpy-docstring-generator/lists"}