| Name | reviewbot-extension JSON |
| Version |
3.2
JSON |
| download |
| home_page | |
| Summary | Review Bot, the automated code reviewer (Review Board extension) |
| upload_time | 2023-05-04 02:39:18 |
| maintainer | Beanbag, Inc. |
| docs_url | None |
| author | Beanbag, Inc. |
| requires_python | >=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.* |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
====================
Review Bot Extension
====================
`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 extension integrates Review Board with one or more
`Review Bot workers`_. It manages the configuration rules which tell Review
Bot when and how to review code, and schedules new review requests for review.
.. _Review Bot: https://www.reviewboard.org/downloads/reviewbot/
.. _Review Bot workers: https://pypi.org/project/reviewbot-worker/
.. _Review Board: https://www.reviewboard.org/
Supported Code Checking Tools
=============================
The Review Bot extension can perform automated code reviews using any of the
following tools:
* `checkstyle
<https://www.reviewboard.org/docs/reviewbot/latest/tools/checkstyle/>`_
- A static analysis tool that provides a variety of checkers for Java code
* `Cppcheck
<https://www.reviewboard.org/docs/reviewbot/latest/tools/cppcheck/>`_
- A static analysis tool for C/C++ code
* `CppLint <https://www.reviewboard.org/docs/reviewbot/latest/tools/cpplint/>`_
- Checks C++ code against Google's style guide
* `flake8 <https://www.reviewboard.org/docs/reviewbot/latest/tools/flake8/>`_
- A wrapper around several Python code quality tools
* `PMD <https://www.reviewboard.org/docs/reviewbot/latest/tools/pmd/>`_
- A static analysis tool that provides checkers for many languages
* `pycodestyle
<https://www.reviewboard.org/docs/reviewbot/latest/tools/pycodestyle/>`_
- A code style checker for Python code
* `pydocstyle
<https://www.reviewboard.org/docs/reviewbot/latest/tools/pydocstyle/>`_
- A static analysis tool for Python docstring conventions
* `pyflakes <https://www.reviewboard.org/docs/reviewbot/latest/tools/pyflakes/>`_
- A static analysis tool for Python code
See the links above for installation and usage instructions.
Installing the Review Bot Extension
===================================
The extension is provided through the reviewbot-extension_ Python package.
See the documentation_ to learn how to install and configure the worker and
the rest of Review Bot.
.. _documentation:
https://www.reviewboard.org/docs/reviewbot/latest/
.. _reviewbot-extension: https://pypi.org/project/reviewbot-extension/
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.
.. _discussion list: https://groups.google.com/group/reviewboard/
.. _support options: https://www.reviewboard.org/support/
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! <https://groups.google.com/group/reviewboard/>`_
.. _Happy Users page: https://www.reviewboard.org/users/
Reporting Bugs
==============
Hit a bug? Let us know by
`filing a bug report <https://www.reviewboard.org/bugs/new/>`_.
You can also look through the
`existing bug reports <https://www.reviewboard.org/bugs/>`_ 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 <https://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`_.
.. _`Contributor Guide`: https://www.reviewboard.org/docs/codebase/dev/
.. _`development discussion list`:
https://groups.google.com/group/reviewboard-dev/
Related Projects
================
* `Review Board`_ -
Our extensible, open source code review tool.
* RBTools_ -
The RBTools command line suite.
* `RB Gateway`_ -
Manages Git repositories, providing a full API enabling all of Review Board's
feaures.
.. _RBTools: https://github.com/reviewboard/rbtools/
.. _ReviewBot: https://github.com/reviewboard/ReviewBot/
.. _RB Gateway: https://github.com/reviewboard/rb-gateway/
Raw data
{
"_id": null,
"home_page": "",
"name": "reviewbot-extension",
"maintainer": "Beanbag, Inc.",
"docs_url": null,
"requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*",
"maintainer_email": "support@beanbaginc.com",
"keywords": "",
"author": "Beanbag, Inc.",
"author_email": "support@beanbaginc.com",
"download_url": "https://files.pythonhosted.org/packages/88/d2/23e84c8b43c3da5bd5bbc690edf1461fa71f04a62dbf5a6b17d3d36c068d/reviewbot-extension-3.2.tar.gz",
"platform": null,
"description": "====================\nReview Bot Extension\n====================\n\n`Review Bot`_ is a tool for automating tasks on code uploaded to `Review\nBoard`_, and posting the results as a code review. Review Bot was built to\nautomate the execution of static analysis tools.\n\nThe Review Bot extension integrates Review Board with one or more\n`Review Bot workers`_. It manages the configuration rules which tell Review\nBot when and how to review code, and schedules new review requests for review.\n\n\n.. _Review Bot: https://www.reviewboard.org/downloads/reviewbot/\n.. _Review Bot workers: https://pypi.org/project/reviewbot-worker/\n.. _Review Board: https://www.reviewboard.org/\n\n\nSupported Code Checking Tools\n=============================\n\nThe Review Bot extension can perform automated code reviews using any of the\nfollowing tools:\n\n* `checkstyle\n <https://www.reviewboard.org/docs/reviewbot/latest/tools/checkstyle/>`_\n - A static analysis tool that provides a variety of checkers for Java code\n\n* `Cppcheck\n <https://www.reviewboard.org/docs/reviewbot/latest/tools/cppcheck/>`_\n - A static analysis tool for C/C++ code\n\n* `CppLint <https://www.reviewboard.org/docs/reviewbot/latest/tools/cpplint/>`_\n - Checks C++ code against Google's style guide\n\n* `flake8 <https://www.reviewboard.org/docs/reviewbot/latest/tools/flake8/>`_\n - A wrapper around several Python code quality tools\n\n* `PMD <https://www.reviewboard.org/docs/reviewbot/latest/tools/pmd/>`_\n - A static analysis tool that provides checkers for many languages\n\n* `pycodestyle\n <https://www.reviewboard.org/docs/reviewbot/latest/tools/pycodestyle/>`_\n - A code style checker for Python code\n\n* `pydocstyle\n <https://www.reviewboard.org/docs/reviewbot/latest/tools/pydocstyle/>`_\n - A static analysis tool for Python docstring conventions\n\n* `pyflakes <https://www.reviewboard.org/docs/reviewbot/latest/tools/pyflakes/>`_\n - A static analysis tool for Python code\n\nSee the links above for installation and usage instructions.\n\n\nInstalling the Review Bot Extension\n===================================\n\nThe extension is provided through the reviewbot-extension_ Python package.\n\nSee the documentation_ to learn how to install and configure the worker and\nthe rest of Review Bot.\n\n.. _documentation:\n https://www.reviewboard.org/docs/reviewbot/latest/\n.. _reviewbot-extension: https://pypi.org/project/reviewbot-extension/\n\n\nGetting Support\n===============\n\nWe can help you get going with Review Bot, and diagnose any issues that may\ncome up. There are three levels of support: Public Community Support, Private\nBasic Support, and Private Premium Support.\n\nThe public community support is available on our main `discussion list`_. We\ngenerally respond to requests within a couple of days. This support works well\nfor general, non-urgent questions that don't need to expose confidential\ninformation.\n\nPrivate Support plans are available through support contracts. We offer\nsame-day support options, handled confidentially over e-mail or our support\ntracker, and can assist with a wide range of requests.\n\nSee your `support options`_ for more information.\n\n\n.. _discussion list: https://groups.google.com/group/reviewboard/\n.. _support options: https://www.reviewboard.org/support/\n\n\nOur Happy Users\n===============\n\nThere are thousands of companies and organizations using Review Board today.\nWe respect the privacy of our users, but some of them have asked to feature them\non the `Happy Users page`_.\n\nIf you're using Review Board, and you're a happy user,\n`let us know! <https://groups.google.com/group/reviewboard/>`_\n\n\n.. _Happy Users page: https://www.reviewboard.org/users/\n\n\nReporting Bugs\n==============\n\nHit a bug? Let us know by\n`filing a bug report <https://www.reviewboard.org/bugs/new/>`_.\n\nYou can also look through the\n`existing bug reports <https://www.reviewboard.org/bugs/>`_ to see if anyone\nelse has already filed the bug.\n\n\nContributing\n============\n\nAre you a developer? Do you want to help build new tools or features for\nReview Bot? Great! Let's help you get started.\n\nFirst off, read through our `Contributor Guide`_.\n\nWe accept patches to Review Bot, Review Board, RBTools, and other related\nprojects on `reviews.reviewboard.org <https://reviews.reviewboard.org/>`_.\n(Please note that we *do not* accept pull requests.)\n\nGot any questions about anything related to Review Board and development? Head\non over to our `development discussion list`_.\n\n.. _`Contributor Guide`: https://www.reviewboard.org/docs/codebase/dev/\n.. _`development discussion list`:\n https://groups.google.com/group/reviewboard-dev/\n\n\nRelated Projects\n================\n\n* `Review Board`_ -\n Our extensible, open source code review tool.\n* RBTools_ -\n The RBTools command line suite.\n* `RB Gateway`_ -\n Manages Git repositories, providing a full API enabling all of Review Board's\n feaures.\n\n.. _RBTools: https://github.com/reviewboard/rbtools/\n.. _ReviewBot: https://github.com/reviewboard/ReviewBot/\n.. _RB Gateway: https://github.com/reviewboard/rb-gateway/\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Review Bot, the automated code reviewer (Review Board extension)",
"version": "3.2",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "55ef1dc18c4b897970cc48e887cc3dd8eda06bbd4677c419778b58d8108b7223",
"md5": "c935a3b598e6a2d9310d05f0eb2c4243",
"sha256": "8074ee3f86c93fd839ee3d0b984933b63d82cd7f9f528b85af43b90ca23fbb14"
},
"downloads": -1,
"filename": "reviewbot_extension-3.2-py2.7.egg",
"has_sig": true,
"md5_digest": "c935a3b598e6a2d9310d05f0eb2c4243",
"packagetype": "bdist_egg",
"python_version": "3.2",
"requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*",
"size": 116103,
"upload_time": "2023-05-04T02:39:15",
"upload_time_iso_8601": "2023-05-04T02:39:15.673423Z",
"url": "https://files.pythonhosted.org/packages/55/ef/1dc18c4b897970cc48e887cc3dd8eda06bbd4677c419778b58d8108b7223/reviewbot_extension-3.2-py2.7.egg",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c1fda51db8a75adc0f5d8dea92e9f754bd150f6888eecc5b6c8442ade20302f1",
"md5": "3fcfda490da988d6debda680ec0a8202",
"sha256": "fee5db0eea80e3c555991503763de3cc7ea6dffd0c441e659141e528016a7c26"
},
"downloads": -1,
"filename": "reviewbot_extension-3.2-py2.py3-none-any.whl",
"has_sig": true,
"md5_digest": "3fcfda490da988d6debda680ec0a8202",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*",
"size": 88118,
"upload_time": "2023-05-04T02:39:13",
"upload_time_iso_8601": "2023-05-04T02:39:13.761748Z",
"url": "https://files.pythonhosted.org/packages/c1/fd/a51db8a75adc0f5d8dea92e9f754bd150f6888eecc5b6c8442ade20302f1/reviewbot_extension-3.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "88d223e84c8b43c3da5bd5bbc690edf1461fa71f04a62dbf5a6b17d3d36c068d",
"md5": "545458124e39b2a829226361fa3a5c8b",
"sha256": "51ea73640a9c0d259fce4634210b6764a562b572fa17788448079e10ec5a7d8e"
},
"downloads": -1,
"filename": "reviewbot-extension-3.2.tar.gz",
"has_sig": true,
"md5_digest": "545458124e39b2a829226361fa3a5c8b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*",
"size": 21669,
"upload_time": "2023-05-04T02:39:18",
"upload_time_iso_8601": "2023-05-04T02:39:18.249542Z",
"url": "https://files.pythonhosted.org/packages/88/d2/23e84c8b43c3da5bd5bbc690edf1461fa71f04a62dbf5a6b17d3d36c068d/reviewbot-extension-3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-04 02:39:18",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "reviewbot-extension"
}
