{"id":21165723,"url":"https://github.com/croketillo/docstring-tool","last_synced_at":"2025-03-14T16:44:10.917Z","repository":{"id":205724760,"uuid":"714340767","full_name":"croketillo/docstring-tool","owner":"croketillo","description":"Include/remove docstrings at any python file found in the specified folder.","archived":false,"fork":false,"pushed_at":"2023-11-06T05:07:52.000Z","size":27,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-21T10:09:38.919Z","etag":null,"topics":["docstring","docstring-documentation","docstring-generator","docstring-tool","docstrings"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/croketillo.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}},"created_at":"2023-11-04T16:12:21.000Z","updated_at":"2023-11-06T05:08:43.000Z","dependencies_parsed_at":"2023-11-06T07:24:59.344Z","dependency_job_id":"1d00f0de-0b0f-45fc-bec0-a0e454b2eb05","html_url":"https://github.com/croketillo/docstring-tool","commit_stats":null,"previous_names":["croketillo/docstring-tool"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/croketillo%2Fdocstring-tool","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/croketillo%2Fdocstring-tool/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/croketillo%2Fdocstring-tool/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/croketillo%2Fdocstring-tool/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/croketillo","download_url":"https://codeload.github.com/croketillo/docstring-tool/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243615244,"owners_count":20319724,"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":["docstring","docstring-documentation","docstring-generator","docstring-tool","docstrings"],"created_at":"2024-11-20T14:45:42.641Z","updated_at":"2025-03-14T16:44:10.884Z","avatar_url":"https://github.com/croketillo.png","language":"Python","readme":"# DocString Tool\n\nDOCSTRING TOOL is a script to include/remove docstrings at the beginning of any python file found in the specified folder.\nThe docstring text is stored in a file that will be specified by the user. It is possible to store tags to include in the text in ```docstring.cnf``` to be able to reuse docstring texts.\n\n\n## Usage\n\n```\nusage: dstr.py [-h] {add,del,show} ...\n\nTool for managing docstrings in .py files\n\npositional arguments:\n  {add,del,show}  Available subcommands\n    add           Add docstrings to .py files [-r for recursive]\n    del           Remove docstrings from .py files [-r for recursive]\n    show          Preview docstring text\n\noptions:\n  -h, --help      show this help message and exit\n```\n\n\n### Usage add/del\n\nAdds or removes the docstring specified in the file to all files with the extension \".py\" in the specified directory.\n\n```\nusage: dstr.py add [-h] [-r] directory text_file\n\npositional arguments:\n  directory        Path to the directory where the .py files are located\n  text_file        Path to the external file with the text for the docstring\n\noptions:\n  -h, --help       show this help message and exit\n  -r, --recursive  Recursive search for .py files \n```\n\n### Usage show\n\nShows how the docstring of the specified file looks like.\n\n```\nusage: dstr.py show [-h] text_file\n\npositional arguments:\n  text_file   Path to the external file with the text for the docstring\n\noptions:\n  -h, --help  show this help message and exit\n```\n\n\n## EXAMPLE\n\n\n``` python3 dstr.py add -r ./test_directory docstring_sample.txt  ```\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcroketillo%2Fdocstring-tool","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcroketillo%2Fdocstring-tool","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcroketillo%2Fdocstring-tool/lists"}