{"id":16735478,"url":"https://github.com/thomasthaddeus/autodocstring","last_synced_at":"2025-03-15T20:46:12.370Z","repository":{"id":203318194,"uuid":"709324294","full_name":"thomasthaddeus/AutoDocstring","owner":"thomasthaddeus","description":null,"archived":false,"fork":false,"pushed_at":"2024-01-01T14:28:30.000Z","size":24,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-22T10:11:08.790Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/thomasthaddeus.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":"2023-10-24T13:43:58.000Z","updated_at":"2023-10-24T15:11:06.000Z","dependencies_parsed_at":null,"dependency_job_id":"3ce6f552-2962-48a7-a22d-313d830b4bb8","html_url":"https://github.com/thomasthaddeus/AutoDocstring","commit_stats":{"total_commits":7,"total_committers":3,"mean_commits":"2.3333333333333335","dds":0.2857142857142857,"last_synced_commit":"c13fa96d67789ae51ff784ed2b63fdd5e4a55440"},"previous_names":["thomasthaddeus/autodocstring"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thomasthaddeus%2FAutoDocstring","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thomasthaddeus%2FAutoDocstring/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thomasthaddeus%2FAutoDocstring/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thomasthaddeus%2FAutoDocstring/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thomasthaddeus","download_url":"https://codeload.github.com/thomasthaddeus/AutoDocstring/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243790950,"owners_count":20348379,"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":[],"created_at":"2024-10-13T00:06:04.181Z","updated_at":"2025-03-15T20:46:12.350Z","avatar_url":"https://github.com/thomasthaddeus.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AutoDocstring\n\nAutoDocstring is a Python tool designed for automatic generation and updating of Python docstrings in the Google style. It simplifies the process of maintaining consistent and comprehensive documentation in Python codebases.\n\n## Features\n\n- Scans Python files in a given directory (including subdirectories) for docstrings.\n- Automatically adds or updates docstrings in Google style.\n- Supports dry-run mode to preview changes without modifying files.\n- Provides options for interactive updates and file backup.\n\n## Requirements\n\n- Python 3.8 or higher\n\n## Installation\n\nClone the repository and install the dependencies using Poetry:\n\n```bash\ngit clone https://github.com/thomasthaddeus/AutoDocstring.git\ncd AutoDocstring\npoetry install\n```\n\n## Usage\n\nRun the tool from the command line:\n\n```bash\npoetry run python src/main.py [directory] [--dry-run] [--interactive]\n```\n\nArguments:\n\n- `directory`: Path to the directory containing Python files to process.\n- `--dry-run`: Preview changes without modifying files.\n- `--interactive`: Interactive mode for manual confirmation of each change.\n\n## Documentation\n\nFor more detailed information about the tool, refer to the documentation in the `docs` directory.\n\n## Contributing\n\nContributions to the AutoDocstring project are welcome! Please refer to the `CONTRIBUTING.md` file for guidelines on how to contribute.\n\n## License\n\nThis project is licensed under the MIT License - see the `LICENSE` file for details.\n\n## Contact\n\nFor any queries or suggestions, feel free to contact the maintainers at [thaddeus.r.thomas@gmail.com].\n\n---\n\n© 2023 [Thaddeus Thomas] - All Rights Reserved\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthomasthaddeus%2Fautodocstring","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthomasthaddeus%2Fautodocstring","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthomasthaddeus%2Fautodocstring/lists"}