Skip to main content

Sweep software chores

Project description

Bug Reports & Feature Requests ⟶  Code Changes

Landing Page Docs PyPI

Sweep allows you to create and review GitHub issues with ease. Simply describe any issue and Sweep will do the rest. It will plan out what needs to be done, what changes to make, and write the changes to a PR.

Supported languages: Python, Javascript/Typescript, Rust, Go, Java/C#, C++ and anything else GPT-4 supports


✨ Demo

For the best experience, install Sweep to one of your repos and see the magic happen.

Demo

🌠 Features

  • Automatic interactive bug fixes & feature development
  • PR auto self-review + comment handling (effectively Reflexion)
  • Address developer comments after PR is created using PR replies & code comments
  • Code snippets embedding-based semantic & popularity search (🔍 Rebuilding our Search Engine in a Day)
  • Chain-of-Thought retrieval using GPT Functions
  • 🎊 New: Sweep Chat, a local interface for Sweep (see below)

🚀 Getting Started

🖥️ Sweep Chat

Sweep Chat allows you to interact with Sweep locally and will sync with GitHub. You can plan out your changes with Sweep, and then Sweep can create a pull request for you.

  1. Install Sweep GitHub app to desired repos

  2. Run pip install sweepai && sweep. Note that you need python 3.10 or greater.

  3. This should spin up a GitHub auth flow in your browser. Copy-paste the 🔵 blue 8-digit code from your terminal into the page. Then wait a few seconds and it should spin up Sweep Chat. You should only need to do the auth once.

  4. Pick a repo from the dropdown at the top (the Github app must be installed on this repo). Then start chatting with Sweep Chat. Relevant searched files will show up on the right. Sweep Chat can make PRs if you ask it to create a PR.

💡 You can force dark mode by going to http://127.0.0.1:7861/?__theme=dark.

From Source

If you want the nightly build and or if the latest build has issues.

  1. git clone https://github.com/sweepai/sweep && poetry install
  2. python sweepai/app/cli.py. Note that you need python 3.10 or greater.

✨ Sweep Github App

Setting up Sweep is as simple as adding the GitHub bot to a repo, then creating an issue for the bot to address.

  1. Add the Sweep GitHub app to desired repos
  2. Create new issue in repo, like "Sweep: Write tests"
  3. "👀" means it is taking a look, and it will generate the desired code
  4. "🚀" means the bot has finished its job and created a PR

🤝 Contributing

Contributions are welcome and greatly appreciated! For detailed guidelines on how to contribute, please see the CONTRIBUTING.md file. In essence, you'll need to fork the repository, create a new branch for your feature or bug fix, commit your changes, and open a pull request. For more detailed docs, see 🚀 Quickstart.


📘 Story

We were frustrated by small tickets, like simple bug fixes, annoying refactors, and small features, each task requiring us to open our IDE to fix simple bugs. So, we decided to leverage the capabilities of ChatGPT to address this directly in GitHub.

Unlike existing AI solutions, this can solve entire tickets and can be parallelized: developers can spin up 10 tickets and Sweep will address them all at once.

📚 The Stack

  • GPT-4 32k 0613 (default) / Claude v1.3 100k
  • ActiveLoop DeepLake for Vector DB with MiniLM L12 as our embeddings model
  • Modal Labs for infra + deployment
  • Gradio for Sweep Chat

🗺️ Roadmap

We're currently working on responding to linters and external search. For more, see 🗺️ Roadmap.

⭐ Star History

Star History Chart

Consider starring us if you're using Sweep so more people hear about us!


Contributors

Thank you for your contribution!

and, of course, Sweep!

Project details


Release history Release notifications | RSS feed

This version

0.3.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sweepai-0.3.0.tar.gz (61.4 kB view details)

Uploaded Source

Built Distribution

sweepai-0.3.0-py3-none-any.whl (70.7 kB view details)

Uploaded Python 3

File details

Details for the file sweepai-0.3.0.tar.gz.

File metadata

  • Download URL: sweepai-0.3.0.tar.gz
  • Upload date:
  • Size: 61.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.10

File hashes

Hashes for sweepai-0.3.0.tar.gz
Algorithm Hash digest
SHA256 ce80fec0ad5d054d65078302d577526a7049c2f8e23019cf7a7dd6603ed12311
MD5 6c0ca7ea71d842ee97eb5a6743f5ef7d
BLAKE2b-256 be44e83ed933283525bd5a2a58e71d52496afbcf335d54b14f28e2f8c55db465

See more details on using hashes here.

File details

Details for the file sweepai-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: sweepai-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 70.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.10

File hashes

Hashes for sweepai-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d5dee06b0126340a75da1d204af0fc6c5869db7fc29bd21e6b80b6316051da6d
MD5 5f31f158f03a41093be0de854bf7646d
BLAKE2b-256 172b7f1d9e7ff8e926c6801e3aabcf280ac0f0109829e624ee207b87588a52a2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page