The AI-powered command line tool for working with legacy code
Project description
Menderbot
The AI-powered command line tool for working with legacy code. Designed based on the principles of the Mechanized Mending Manifesto.
Status
Menderbot is usable in development of itself - a very small codebase. For instance, it's used on this project for first drafts of commit messages, it added most of the type annotations, and chat usually gives relevant answers. On codebases of an interesting size (> 10K lines) there is still much work to do.
Commands implemented (-ish):
menderbot ask
: Ask a question about the codebasemenderbot chat
: Interactively chat about the codebasemenderbot commit
: Git commit the current changeset with a pre-populated commit messagemenderbot diff
: Summarize the differences between two versions of a codebasemenderbot doc
: Generate documentation for the existing code (Python only)menderbot review
: Review a code block or changeset and provide feedbackmenderbot type
: Insert type hints (Python only)menderbot ingest
: Index the current state of the repo forask
andchat
commandsmenderbot check
: Verify we have what we need to run
System requirements
- git
- Python 3.9+
- Make (you already have it)
- The environment variable
OPENAI_API_KEY
set to a valid OpenAI API Key.
Running
Clone the project...
Install an editable version (this uses pip install -e .
):
git clone git@github.com:craftvscruft/menderbot.git
make install
Then run with menderbot
in any repo.
Installing from pip
You can also install directly from pip and avoid cloning the repo:
pip install menderbot --upgrade
Running with Docker
If you don't have Python, you can run from Docker using the supplied Dockerfile. Run make docker
to build the image and print instructions on how to run it.
Developing
Clone the project...
git clone git@github.com:craftvscruft/menderbot.git
Then you can initialize your Python environment using venv.
make venv
source venv/bin/activate
pip install "." ".[dev]"
If you want to re-generate the Antlr parsers, see PARSERS.md, but you probably won't need to.
Testing
Formatting, linting, tests, and type-checking can all be run with make, check the Makefile
for the underlying commands. Run before commiting, or CI will bark :)
make check
Or you can run individual steps
# Run pytest
make test
# Run pytest with a coverage report
make coverage
# Run mypy
make type
# Run pylint
make lint
# Run black and isort
make format
Author
👤 Ray Myers
- YouTube: Craft vs Cruft
- Twitter: @lambdapocalypse
- GitHub: @raymyers
- LinkedIn: @cadrlife
🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide.
Show your support
Give a ⭐️ if this project helped you!
Acknowledgements
- OpenAI GPT and Ada models
- LlamaIndex, an LLM data framework
- Antlr parser generator
📝 License
Copyright © 2023 Ray Myers.
This project is Apache 2 licensed.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for menderbot-0.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3c0cf622e6ddb91114729e8de6c65babd6ae4e3fd8ed38b9377907fb97541dc6 |
|
MD5 | 8e3062cb18d7bc006a005b5cf42d6e1b |
|
BLAKE2b-256 | e64cf4cd5914b304007ade82e202612dc4db71747c34d29b840c16ab9aa06158 |