AI-powered python code documentation and test generation tool

Write-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.

Real-world examples

• write-the docs to write the docs for the write-the docs command 🤖
• write-the mkdocs to build the documentation site for write-the 🤖
• write-the tests to write tests for write-the docs 🤖
• write-the docs and write-the mkdocs to build documenation for autoresearcher 🤖
• write-the docs and write-the mkdocs to build documenation for CUPCAKEAGI 🤖

Installation

pip install write-the

write-the should ideally be installed in an isolated enviroment with a tool like pipx.

pipx install write-the

Features

Write-the offers the following AI-driven features:

• Write-the Docs: Automatically generate documentation for your codebase, including class and function descriptions, parameter explanations, and examples.
• Write-the Tests: Create test cases for your code, ensuring thorough test coverage and better code quality.
• Write-the Convert: Convert code and data from any format into another.

In addition write-the can also manage OpenAI models and scaffold MkDocs websites.

Requirements

• Python 3.9 or higher
• OpenAI API key

To use write-the you must set an OPENAI_API_KEY environment variable (e.g. export OPENAI_API_KEY=...).

See https://platform.openai.com/api-keys for details.

Documentation

For detailed information on available options and parameters, refer to the official (write-the generated) documentation.

Roadmap

The 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.

For a detailed project roadmap, including planned features, improvements, and milestones, please see our Project Timeline (TBD).

Contributing

We welcome contributions from the community. If you would like to contribute to Write-The, please follow these steps:

• Fork the repository and create a new branch for your feature or bugfix.
• Develop your changes and ensure that your code follows the project's coding standards.
• Create a pull request with a clear description of your changes and any relevant documentation.
• For more information on contributing, please see our Contributing Guide.

License

write-the is distributed under the terms of the MIT license.