Skip to main content

Sweep software chores

Project description

Spend time reviewing code generated by AI, not writing it.

📚 Docs   •   📢 Discord

Sweep allows you to create and review GitHub issues with easy. 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.


✨ Demo

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

Demo

🚀 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

  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.

✨ Sweep Github App

Set ting 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

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

🌠 Features

  • Automatic feature development
  • PR auto self-review + comment handling (effectively Reflexion)
  • Address developer comments after PR is created
  • Code snippets embedding-based search
  • Chain-of-Thought retrieval using GPT Functions

🗺️ Roadmap

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


Contributors

Thank you for your contribution!

and, of course, Sweep!

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

sweepai-0.1.11.tar.gz (56.2 kB view details)

Uploaded Source

Built Distribution

sweepai-0.1.11-py3-none-any.whl (66.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for sweepai-0.1.11.tar.gz
Algorithm Hash digest
SHA256 e184f46174aa30e7dbcf5b9361a52252401315c056da056a46fc2193403c8e62
MD5 6e724efa3080e02ef99ab9370a0ee676
BLAKE2b-256 9ffc78ebcdbf427536ba39721cf555db22515b69f9401c8e56ddc2709ec6b28d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sweepai-0.1.11-py3-none-any.whl
  • Upload date:
  • Size: 66.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.1.11-py3-none-any.whl
Algorithm Hash digest
SHA256 18e259dca7c99328cce29bc406ddb8adf35eea7b31bac33c4dbd27f68eed34f3
MD5 5cc873643130bace389bc86d423dda75
BLAKE2b-256 36261eb3e9a8ead8912cd318dd9aea9aa7643e1915869dbf59575a829264f88b

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