Module and Class References¶

Top-Level Modules¶

`rbtools`	RBTools version and package information.
`rbtools.deprecation`	Internal support for handling deprecations in RBTools.

`rbtools.api`
`rbtools.api.cache`	Caching implementation for the RBTools API.
`rbtools.api.capabilities`	Review Board server capability management.
`rbtools.api.client`
`rbtools.api.decode`	API payload decoders.
`rbtools.api.decorators`
`rbtools.api.errors`	Error classes and codes for API communication.
`rbtools.api.factory`
`rbtools.api.request`
`rbtools.api.resource`	Resource definitions for the RBTools Python API.
`rbtools.api.transport`
`rbtools.api.transport.sync`
`rbtools.api.utils`	API-specific MIME type utilities.

`rbtools.clients`	Support for interfacing with source code management systems.
`rbtools.clients.base`	Base support for defining SCMClients.
`rbtools.clients.base.patch`	Classes for representing patch results in SCM clients.
`rbtools.clients.base.registry`	Registry of available SCMClients.
`rbtools.clients.base.repository`	Classes for representing source code repositories.
`rbtools.clients.base.scmclient`	Base class for interfacing with source code management tools.
`rbtools.clients.errors`	Error definitions for SCMClient implementations.

`rbtools.clients.bazaar`	A client for Bazaar and Breezy.
`rbtools.clients.clearcase`	A client for ClearCase.
`rbtools.clients.cvs`	A client for CVS.
`rbtools.clients.git`	A client for Git.
`rbtools.clients.mercurial`	A client for Mercurial.
`rbtools.clients.perforce`	A client for Perforce.
`rbtools.clients.plastic`	A client for Plastic SCM.
`rbtools.clients.sos`	A client for Cliosoft SOS.
`rbtools.clients.svn`	A client for Subversion.
`rbtools.clients.tfs`	A client for Team Foundation Server.

`rbtools.config`	Configuration management for RBTools.
`rbtools.config.config`	Configuration for RBTools.
`rbtools.config.loader`	Loaders for configuration files.

`rbtools.diffs`	Utilities and support for generating and processing diffs.
`rbtools.diffs.tools`	Support for working with external diff tools.
`rbtools.diffs.tools.backends`	Diff tool backends for specific external tools.
`rbtools.diffs.tools.backends.gnu`	A diff tool interfacing with GNU Diff.
`rbtools.diffs.tools.base`	Base support for creating diff tools.
`rbtools.diffs.tools.base.diff_file_result`	Classes for working with the result of a diff between files.
`rbtools.diffs.tools.base.diff_tool`	Base class for building diff tools.
`rbtools.diffs.tools.errors`	Errors for working with diff tools.
`rbtools.diffs.tools.registry`	Registry of available diff tools.
`rbtools.diffs.writers`	Writers to help programmatically generate new diffs.

`rbtools.commands`	Base support for creating commands.
`rbtools.commands.main`	Main handler for the rbt command.

`rbtools.commands`	Base support for creating commands.
`rbtools.commands.base.commands`	Base classes for commands.
`rbtools.commands.base.errors`	Error types for commands.
`rbtools.commands.base.options`	Command line option management for commands.
`rbtools.commands.base.output`	Output management for commands.

`rbtools.commands.alias`	Implementation of rbt alias.
`rbtools.commands.api_get`	Implementation of rbt api-get.
`rbtools.commands.attach`	Implementation of rbt attach.
`rbtools.commands.clearcache`	Implementation of rbt clear-cache.
`rbtools.commands.close`	Implementation of rbt close.
`rbtools.commands.diff`	Implementation of rbt diff.
`rbtools.commands.info`	The rbt info command.
`rbtools.commands.install`	Implementation of rbt install.
`rbtools.commands.land`	Implementation of rbt land.
`rbtools.commands.list_repo_types`	Implementation of rbt list-repo-types.
`rbtools.commands.login`	Implementation of rbt login.
`rbtools.commands.logout`	Implementation of rbt logout.
`rbtools.commands.patch`	Implementation of rbt patch.
`rbtools.commands.post`	Implementation of rbt post.
`rbtools.commands.publish`	Implementation of rbt publish.
`rbtools.commands.review`	Implementation of rbt review.
`rbtools.commands.setup_completion`	Implementation of rbt setup-completion.
`rbtools.commands.setup_repo`	Implementation of rbt setup-repo.
`rbtools.commands.stamp`	Implementation of rbt stamp.
`rbtools.commands.status`	Implementation of rbt status.
`rbtools.commands.status_update`	Implementation of rbt status-update.

`rbtools.hooks`
`rbtools.hooks.common`	Common functionality for working with repository hooks.

Git repository hook utilities.

`rbtools.testing`	Common support for writing unit tests for RBTools.
`rbtools.testing.api`
`rbtools.testing.api.payloads`	API payload generation factory for unit tests.
`rbtools.testing.api.transport`	API transports for unit tests.
`rbtools.testing.commands`	Command unit testing support.
`rbtools.testing.testcase`	Base test cases for RBTools unit tests.
`rbtools.testing.transport`	Transport subclass used for unit testing.

`rbtools.utils`
`rbtools.utils.aliases`	Utilities for working with command aliases.
`rbtools.utils.browser`	Utilities for working with web browsers.
`rbtools.utils.checks`	Utilities for checking for dependencies.
`rbtools.utils.commands`	Utilities for commands.
`rbtools.utils.console`	Utilities for working with console interactions.
`rbtools.utils.diffs`	Utilities for generating or parsing diffs.
`rbtools.utils.encoding`	Utilities for managing string types and encoding.
`rbtools.utils.errors`	Error classes for utility functions.
`rbtools.utils.filesystem`	Utilities for working with files.
`rbtools.utils.graphs`	Topological graphing and sorting utilities.
`rbtools.utils.mimetypes`	Utilities for working with MIME types.
`rbtools.utils.process`	Utilities for running processes.
`rbtools.utils.repository`	Utility functions for working with repositories.
`rbtools.utils.review_request`	Utilities for matching review requests.
`rbtools.utils.source_tree`	Utilities for scanning and working with source trees.
`rbtools.utils.users`	Utilities for working with user sessions.