Skip to main content

Review Bot, the automated code reviewer (worker)

Project description

Review Bot is a tool for automating tasks on code uploaded to Review Board, and posting the results as a code review. Review Bot was built to automate the execution of static analysis tools.

The Review Bot worker is the service component of Review Bot that performs the code reviews, managed by the Review Bot extension. Workers on be installed on a single server, or can be distributed across several, helping to review large numbers of changes at once.

Supported Code Checking Tools

The Review Bot worker can perform automated code reviews using any of the following tools:

  • checkstyle - A static analysis tool that provides a variety of checkers for Java code

  • Cppcheck - A static analysis tool for C/C++ code

  • CppLint - Checks C++ code against Google’s style guide

  • flake8 - A wrapper around several Python code quality tools

  • PMD - A static analysis tool that provides checkers for many languages

  • pycodestyle - A code style checker for Python code

  • pydocstyle - A static analysis tool for Python docstring conventions

  • pyflakes - A static analysis tool for Python code

See the links above for installation and usage instructions.

Installing the Review Bot Worker

The worker is provided through the reviewbot-worker Python package.

See the documentation to learn how to install and configure the worker and the rest of Review Bot.

Getting Support

We can help you get going with Review Bot, and diagnose any issues that may come up. There are three levels of support: Public Community Support, Private Basic Support, and Private Premium Support.

The public community support is available on our main discussion list. We generally respond to requests within a couple of days. This support works well for general, non-urgent questions that don’t need to expose confidential information.

Private Support plans are available through support contracts. We offer same-day support options, handled confidentially over e-mail or our support tracker, and can assist with a wide range of requests.

See your support options for more information.

Our Happy Users

There are thousands of companies and organizations using Review Board today. We respect the privacy of our users, but some of them have asked to feature them on the Happy Users page.

If you’re using Review Board, and you’re a happy user, let us know!

Reporting Bugs

Hit a bug? Let us know by filing a bug report.

You can also look through the existing bug reports to see if anyone else has already filed the bug.

Contributing

Are you a developer? Do you want to help build new tools or features for Review Bot? Great! Let’s help you get started.

First off, read through our Contributor Guide.

We accept patches to Review Bot, Review Board, RBTools, and other related projects on reviews.reviewboard.org. (Please note that we do not accept pull requests.)

Got any questions about anything related to Review Board and development? Head on over to our development discussion list.

Project details


Download files

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

Source Distribution

reviewbot-worker-4.0.tar.gz (110.9 kB view details)

Uploaded Source

Built Distribution

reviewbot_worker-4.0-py2.py3-none-any.whl (151.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file reviewbot-worker-4.0.tar.gz.

File metadata

  • Download URL: reviewbot-worker-4.0.tar.gz
  • Upload date:
  • Size: 110.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for reviewbot-worker-4.0.tar.gz
Algorithm Hash digest
SHA256 4397e3ed29d90300e79583a720fcf9036065ba69192499f259318797898b5b38
MD5 6d983df38162bed44598fc026bfe2589
BLAKE2b-256 d39a8fa54c396cca49c7493425131f5bc4181cc633d898a59f9175eb7e43a0c3

See more details on using hashes here.

File details

Details for the file reviewbot_worker-4.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for reviewbot_worker-4.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e567b2617bba68e3de3347d300ed710fad5a854a9ed3077eb719df4be3899d7a
MD5 f98d41db5513d7802d7f7b1e1cf3eead
BLAKE2b-256 12bf40d6776d65aa3e0891b10d4944f21570a85fb011526977d4f6709d65c140

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 Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page