Skip to main content

Sweep fixes GitHub issues

Project description

Github Issues ⟶  Pull Requests!

Install Sweep Github App Docker Pulls Docs PyPI version Self Host Sweep Docker Image Python Unit Tests


Sweep is an AI junior developer that turns bugs and feature requests into code changes. Sweep automatically handles devex improvements like adding typehints/improving test coverage. :robot:

Install Sweep and open a Github Issue like: Sweep: Add typehints to src/utils/github_utils.py and Sweep will:

  1. Search through your codebase to find the dependencies of github_utils.py
  2. Modify the code to add typehints
  3. Run and debug your code to write a Pull Request

Features

  • Turns issues directly into pull requests (without an IDE)
  • Addresses developer replies & comments on its PRs
  • Understands your codebase using the dependency graph, text, and vector search.
  • Runs your unit tests and autoformatters to validate generated code.
  • Stack small fixes into your PR by applying Sweep Rules

Sweep Youtube Tutorial

[!NOTE]

What makes Sweep Different

We've been addressing code modification using LLMs for a while. We found and are fixing a lot of issues.

  • Modifying Code - LLMs like GPT4 don't have a great way to automatically modify code. We heavily experiment on different ways to modify code so you don't have to. We've spent a really long time working on this - check out https://docs.sweep.dev/blogs/gpt-4-modification!
  • Planning Code Changes - Retrieval-Augmented-Generation isn't enough. We wrote a code chunker that's used fairly heavily, and we're constantly improving this: https://docs.sweep.dev/blogs/chunking-improvements
  • Sweep runs your Github Actions, catching bugs and making sure each line of new code has been properly validated!
  • Sweep uses it's sandbox to format your code, and uses Rules to perform other changes like adding typehints, or any other small chores!

Getting Started

GitHub App

Install Sweep by adding the Sweep GitHub App to your desired repositories.

  • For more details, visit our installation page.

  • Note: Sweep only considers issues with the "Sweep:" title on creation and not on update. If you want Sweep to pick up an existing issue, you can add the "Sweep" label to the issue.

  • We focus on Python but support all languages GPT-4 can write. This includes JS/TS, Rust, Go, Java, C# and C++.


Story

We used to work in large, messy repositories, and we noticed how complex the code could get without regular refactors and unit tests. We realized that AI could handle these chores for us, so we built Sweep!

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

Highlights

Examine pull requests created by Sweep!

Pricing

Every user receives unlimited GPT-3.5 tickets and 5 GPT-4 tickets per month. For professionals who want to try unlimited GPT-4 tickets and priority support, you can get a one week free trial of Sweep Pro.

For more GPT-4 tickets visit our payment portal!

You can get enterprise support by contacting us.


[!WARNING]

Limitations of Sweep

  • Large-scale refactors: > 10 files or > 400 lines of code changes * e.g. Refactor the entire codebase from TensorFlow to PyTorch * If this is a use case you're looking forward to, let us know!
  • Reading or editing images and other non-text assets * e.g. Use the logo to create favicons for our landing page

Contributing

Contributions are welcome and greatly appreciated! To get set up, see Development. For detailed guidelines on how to contribute, please see the CONTRIBUTING.md file.

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-2.1.1.tar.gz (251.2 kB view details)

Uploaded Source

Built Distribution

sweepai-2.1.1-py3-none-any.whl (285.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sweepai-2.1.1.tar.gz
  • Upload date:
  • Size: 251.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.12

File hashes

Hashes for sweepai-2.1.1.tar.gz
Algorithm Hash digest
SHA256 62a4ddcaebfe71b55ce4fccef232de81c34025c265a3daa0d131effa69242606
MD5 318f3c48da34e6bf9444f93c34d2fa34
BLAKE2b-256 5677a985afea7814ac5c28b7c1ec3dab46c0b7a2a15ebf40957677b70084e866

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sweepai-2.1.1-py3-none-any.whl
  • Upload date:
  • Size: 285.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.12

File hashes

Hashes for sweepai-2.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b88a56bbdc8a993af4810e56b600ffb4d364384ff42ea189babce7c3859a4b96
MD5 3f235ec140b4903cf4da7be0140bc4d6
BLAKE2b-256 c087e37942e3238fccd3ab12817bb829154d1f5af965b5f6d0c48808814570cf

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