{"id":50396276,"url":"https://github.com/Wytamma/write-the","last_synced_at":"2026-06-16T13:00:40.851Z","repository":{"id":153140666,"uuid":"628299078","full_name":"Wytamma/write-the","owner":"Wytamma","description":"AI-powered Documentation and Test Generation Tool","archived":false,"fork":false,"pushed_at":"2025-06-26T05:11:17.000Z","size":4776,"stargazers_count":121,"open_issues_count":11,"forks_count":15,"subscribers_count":3,"default_branch":"master","last_synced_at":"2026-04-15T10:08:33.311Z","etag":null,"topics":["ai","cli","docs","gtp","tests","workflow"],"latest_commit_sha":null,"homepage":"http://write-the.wytamma.com","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/Wytamma.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.txt","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},"funding":{"github":"Wytamma","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2023-04-15T14:15:13.000Z","updated_at":"2026-03-16T07:01:53.000Z","dependencies_parsed_at":"2024-01-09T23:27:51.309Z","dependency_job_id":"60acb3fa-146d-41d9-8c13-a04b94d3c108","html_url":"https://github.com/Wytamma/write-the","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/Wytamma/write-the","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Wytamma%2Fwrite-the","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Wytamma%2Fwrite-the/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Wytamma%2Fwrite-the/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Wytamma%2Fwrite-the/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Wytamma","download_url":"https://codeload.github.com/Wytamma/write-the/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Wytamma%2Fwrite-the/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34406824,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-16T02:00:06.860Z","response_time":126,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["ai","cli","docs","gtp","tests","workflow"],"created_at":"2026-05-30T21:01:21.424Z","updated_at":"2026-06-16T13:00:40.836Z","avatar_url":"https://github.com/Wytamma.png","language":"Python","funding_links":["https://github.com/sponsors/Wytamma"],"categories":["Browse The Shelves"],"sub_categories":["Documentation agents"],"readme":"![](https://raw.githubusercontent.com/Wytamma/write-the/master/images/logo.png)\n\nAI-powered python code documentation and test generation tool\n\n[![PyPI - Version](https://img.shields.io/pypi/v/write-the.svg)](https://pypi.org/project/write-the)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/write-the.svg)](https://pypi.org/project/write-the)\n[![write-the - docs](https://badgen.net/badge/write-the/docs/blue?icon=https://raw.githubusercontent.com/Wytamma/write-the/master/images/write-the-icon.svg)](https://write-the.wytamma.com/)\n[![write-the - test](https://badgen.net/badge/write-the/tests/green?icon=https://raw.githubusercontent.com/Wytamma/write-the/master/images/write-the-icon.svg)](https://github.com/Wytamma/write-the/actions/workflows/tests.yml)\n[![codecov](https://codecov.io/gh/Wytamma/write-the/branch/master/graph/badge.svg?token=yEDn56L76k)](https://app.codecov.io/gh/Wytamma/write-the/tree/master)\n\nWrite-the is an AI-powered documentation and test generation tool that leverages Generative Pre-trained Transformers (GPTs) / Large Language Models (LLMs) to automatically write tests, generate documentation, and refactor code. It is designed to streamline the development process, improve code quality, and increase productivity.\n\n![](https://raw.githubusercontent.com/Wytamma/write-the/master/images/write-the-docs.gif)\n\n## Real-world examples\n\n- [`write-the docs` to write the docs for the `write-the docs` command 🤖](https://github.com/Wytamma/write-the/blob/5d7a5a22d082be6ee870c694ef2d24e6d1610758/write_the/commands/docs/docs.py#L26)\n- [`write-the mkdocs` to build the documentation site for `write-the` 🤖](https://write-the.wytamma.com/)\n- [`write-the tests` to write tests for `write-the docs` 🤖](https://github.com/Wytamma/write-the/commit/6b6c8a08d7991e07e4972281c471f7842c04dda0)\n- [`write-the docs` and `write-the mkdocs` to build documenation for `autoresearcher` 🤖](https://github.com/eimenhmdt/autoresearcher/pull/17)\n- [`write-the docs` and `write-the mkdocs` to build documenation for `CUPCAKEAGI` 🤖](https://github.com/AkshitIreddy/CUPCAKEAGI/pull/4)\n\n## Installation\n```console\npip install write-the\n```\n\n`write-the` should ideally be installed in an isolated enviroment with a tool like [`pipx`](https://github.com/pypa/pipx).\n\n```console\npipx install write-the\n```\n\n## Features\n\nWrite-the offers the following AI-driven features:\n\n- [Write-the Docs](https://write-the.wytamma.com/commands/docs/): Automatically generate documentation for your codebase, including class and function descriptions, parameter explanations, and examples.\n- [Write-the Tests](https://write-the.wytamma.com/commands/tests/): Create test cases for your code, ensuring thorough test coverage and better code quality.\n- [Write-the Convert](https://write-the.wytamma.com/commands/convert/): Convert code and data from any format into another. \n\nIn addition write-the can also [manage OpenAI models](https://write-the.wytamma.com/commands/model/) and [scaffold MkDocs websites](https://write-the.wytamma.com/commands/mkdocs/).\n\n## Requirements\n- Python 3.9 or higher  \n- OpenAI API key\n\nTo use `write-the` you must set an `OPENAI_API_KEY` environment variable (e.g. `export OPENAI_API_KEY=...`).\n\nSee [https://platform.openai.com/api-keys](https://platform.openai.com/api-keys) for details.\n\n## Documentation\n\nFor detailed information on available options and parameters, refer to the official (`write-the` generated) [documentation](https://write-the.wytamma.com/).\n\n## Roadmap\n\nThe main goal for write-the is to develop a generic module system to document, test, and optimise code in any language in a reliable and repatable way.\n\nFor a detailed project roadmap, including planned features, improvements, and milestones, please see our Project Timeline (TBD).\n\n## Contributing\nWe welcome contributions from the community. If you would like to contribute to Write-The, please follow these steps:\n\n- Fork the repository and create a new branch for your feature or bugfix.\n- Develop your changes and ensure that your code follows the project's coding standards.\n- Create a pull request with a clear description of your changes and any relevant documentation.\n- For more information on contributing, please see our Contributing Guide.\n\n## License\n`write-the` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FWytamma%2Fwrite-the","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FWytamma%2Fwrite-the","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FWytamma%2Fwrite-the/lists"}