RBTools Documentation¶
RBTools is a set of client tools to use with Review Board.
Using RBTools¶
rbt¶
The recommended command-line interface is the rbt tool. This tool runs on Windows, Linux, and MacOS X, and allows executing a number of useful sub-commands. rbt has the following usage:
$ rbt [--version] <command> [options] [<args>]
The rbt command obsoletes the old “post-review” command. For built in help you may execute:
$ rbt help
Python API¶
Included with RBTools is a Python client for interacting with the Review Board Web API.
Note
This documentation assumes knowledge of the Review Board Web API. When possible links will be provided to relevant sections of the Web API documentation which can be found in the Web API Guide.
- Overview of the Python API Client
- Tutorial
- Resource-Specific Functionality
- Root List Resource Functionality
- Diff List Resource Functionality
- Diff Resource Functionality
- File Diff Resource Functionality
- File Attachment List Resource Functionality
- Draft File Attachment List Resource Functionality
- Screenshot List Resource Functionality
- Draft Screenshot List Resource Functionality
- Review Request Resource Functionality
Installation¶
Before installing RBTools, you will need to have both Python and setuptools installed.
We require Python 2.4 or higher. We recommend installing Python 2.7. The 3.x releases will not work.
Installing Python¶
Linux¶
Python 2.x should come with your distribution. If not, or if 2.x isn’t installed, you will need to install the appropriate package. Please refer to your package manager for the appropriate version.
Mac OS X¶
Python 2.x comes pre-installed on Mac OS X.
Windows¶
You can install Python by running the latest Python 2.7 Installer for Windows. We recommend the 32-bit MSI installer, as setuptools is not packaged for 64-bit.
Installing setuptools¶
Linux and Mac OS X¶
To install setuptools on Debian, Ubuntu, or another Debian-based distribution, type:
$ apt-get install python-setuptools
To install on Fedora 8 and above, type:
$ yum install -y python-setuptools-devel.noarch
To install on a RedHat Enterprise, CentOS, Fedora 7 and earlier, or another RedHat-based distribution, type:
$ yum install python-setuptools
Users of other distributions should check with their distribution for native packages, or follow the setuptools installation instructions.
If the version of setuptools available for your distribution is older than 0.6c9, you’ll need to install it first, and then upgrade it to the latest version by running:
$ easy_install -U setuptools
Windows¶
You’ll then need to run the latest Python setuptools Installer (look toward the bottom of the page for the file listing).
Once Python and setuptools are installed, you may need to add a couple directories to your system path.
- Open and navigate to the System icon.
- Click on the Advanced tab.
- Click Environment Variables.
- Find
PATHin System variables and click Edit. - Add
;C:\Python27;C:\Python27\Scripts(substitute your Python directory if it’s notC:\Python27) to the end of the list.
Depending on your version control system, you may also need to install the
command-line version of the client. Graphical clients like TortoiseCVS or
TortoiseSVN are not sufficient, and a cvs or svn binary is required.
Installing RBTools¶
Once Python and Setuptools are installed, you can install RBTools just by typing:
$ easy_install -U RBTools
Installing GNU Diff¶
Depending on your version control system, you may also need to install GNU diff. Linux and Mac OS X should come with GNU diff pre-installed. On Windows, you can use the GNU Diffutils Installer
Special Files¶
The rbt command stores its login session in a file called
~/.rbtools-cookies. It can also read this information from a file called
~/.post-review-cookies.txt, which was used by the deprecated
post-review command.