wytamma / write-the

AI-powered Documentation and Test Generation Tool

AI-powered python code documentation and test generation tool

Write-the is an AI-powered documentation and test generation tool that leverages GPTs 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 hyperspec 🤖
• write-the docs and write-the mkdocs to build documenation for CUPCAKEAGI 🤖

Installation

pip 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=...).

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.

write-the's Issues

Add windows to CI

Relates to #22

Better support for long functions

Might need to break up long functions into chunks so that they can fit into context. #20

Does this only work for `.py` files?

Based on this line, I'm assuming this will only generate docs, etc... for python files?

write-the/write_the/cli/main.py

Line 79 in 4b2a247

assert file.suffix == ".py"

If that's accurate, will this support more file types / langs in the future? I think the simple syntax for this is great!

Update base model `text-davinci-003` has been deprecate

InvalidRequestError: The model text-davinci-003 has been deprecated, learn more here: https://platform.openai.com/docs/deprecations

🐛 write-the docs removes comments

Because write-the docs parses the code in a AST comments are lost. One option would be to use the ast-comments package.

Missing dependency upstream

It looks like langchain is missing pexpect as a dependency (see langchain-ai/langchain#3664). Might be worth adding it as an explicit dependency here until a new langchain release comes out?

batch large files

Add a --batch option to send all nodes in separate requests.

fix docstring indentation

write-the comments

Subcommand to add inline comments to a code base.

Swap libcst for tree-sitter

Swapping from libcst to tree-sitter will give write-the multi language support.

https://github.com/tree-sitter/tree-sitter

Integrate guidance

Use guidance prompt language to get more control and reduce token use https://github.com/microsoft/guidance

Idea: write-the bio

Would try and write a bio about a person,
maybe with focus on github tool authors.

Integrate LlamaIndex for codebase wide operations

Using LlamaIndex and some vector datastore it should be possible to perform codebase wide operations like refactors and summaries (#14).

Add —update option to docs

Add an option to update existing docstrings.

Compatibility with cohere's trial api key

OpenAI Connection Error

I kept on having this OpenAI Connection Error. I'm sure it's not because of the API Keys as I have tested via Postman.

Any idea what this might be?

README file omits Open AI API key configuration

Great job with this package. Appears to be very useful. My 2 cents on the README file. It appears to not describe how to point the package to an OpenAI API key. Perhaps I've missed something obvious in which case I apologise

Add typedoc

Add type doc support - https://github.com/TypeStrong/typedoc

Idea: write-the synopsis

Related to docs I guess, but write a synopsis of a tool.

write-the model config is stored globally

Not sure if this is a feature or a bug but write-the model config is stored globally so all write-the installs on a system will use the same default model.