{"id":34045748,"url":"https://github.com/saikatkumardey/aidoc","last_synced_at":"2026-04-05T11:32:44.955Z","repository":{"id":65185582,"uuid":"586179443","full_name":"saikatkumardey/aidoc","owner":"saikatkumardey","description":"A simple CLI tool to generate documentation for your Python projects automatically.","archived":false,"fork":false,"pushed_at":"2023-01-13T05:03:29.000Z","size":58,"stargazers_count":10,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-12-15T16:36:22.550Z","etag":null,"topics":["documentation-generator","machine-learning","openai","python"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/aidoc/","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/saikatkumardey.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":"2023-01-07T08:04:47.000Z","updated_at":"2024-01-02T13:25:03.000Z","dependencies_parsed_at":"2023-02-09T14:32:50.570Z","dependency_job_id":null,"html_url":"https://github.com/saikatkumardey/aidoc","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/saikatkumardey/aidoc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saikatkumardey%2Faidoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saikatkumardey%2Faidoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saikatkumardey%2Faidoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saikatkumardey%2Faidoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/saikatkumardey","download_url":"https://codeload.github.com/saikatkumardey/aidoc/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saikatkumardey%2Faidoc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31434624,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-05T08:13:15.228Z","status":"ssl_error","status_checked_at":"2026-04-05T08:13:11.839Z","response_time":75,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["documentation-generator","machine-learning","openai","python"],"created_at":"2025-12-13T23:20:01.311Z","updated_at":"2026-04-05T11:32:44.946Z","avatar_url":"https://github.com/saikatkumardey.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![PyPI](https://badge.fury.io/py/aidoc.svg)](https://pypi.org/project/aidoc/)\n\n# aidoc\n\naidoc is a command line interface (CLI) tool that uses AI to automatically generate documentation for your code.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"600\" src=\"demo/demo.svg\"\u003e\n\u003c/p\u003e\n\n## Requirements\n\n- OpenAI API key: [https://beta.openai.com/](https://beta.openai.com/)\n- Python 3.6 or higher\n\n## Installation\n\n- globally install the package\n\n```\npython3 -m pip install aidoc\n```\n\n- (recommended) create a virtual environment and install the package\n\n```bash\npip install aidoc\n```\n\n## Usage\n\nTo configure the API key and model for aidoc, run the following command:\n\n```\naidoc configure\n```\n\nTo generate documentation for a source file or directory, run the following command:\n\n```\naidoc gen \u003csource_file\u003e\n```\n\nYou can also specify the following optional arguments:\n\n- `-o` or `--overwrite`: Overwrite existing docstrings\n- `-f` or `--format`: Format the entire source file using black (default=True)\n- `-pr` or `--pull-request`: Create a pull request with the changes\n\n## Examples\n\n**Generate docstrings for the main.py file:**\n\n```\naidoc gen main.py\n```\n\n**Generate docstrings for all Python files in the src directory and its subdirectories:**\n\n```\naidoc gen src\n```\n\n**Generate docstrings and create a pull request with the changes:**\n\n```\naidoc gen main.py -pr\n```\n\n## Which model to choose?\n\n- `code-davinci-002`\n  - most capable codex model\n  - generated docstrings are more accurate and detailed\n- `code-cushman-001`\n  - slightly faster.\n  - generated docstrings are less accurate\n\nTo learn more see [https://beta.openai.com/docs/models/codex](https://beta.openai.com/docs/models/codex)\n\n## Contributing\n\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\n## License\n\nThis project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details.\n\n## Acknowledgments\n\n* [OpenAI](https://openai.com/)\n\n## Disclaimer\n\nThis project is not affiliated with OpenAI. The OpenAI API and GPT-3 language model are not free. You will need to sign up for a free [OpenAI](https://beta.openai.com/) account and create an API key to use this tool.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaikatkumardey%2Faidoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsaikatkumardey%2Faidoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaikatkumardey%2Faidoc/lists"}