Welcome to RepoBee’s documentation!

If you are new to RepoBee, the Introduction and RepoBee User Guide sections are must-reads. Developers looking to modify or utilize the core functionality in ways the CLI does not allow will be best served by looking at the Module Index.

Important

If you use the RepoBee User Guide in any way and feel like skipping Getting started (the show-config, verify-settings and setup commands), make sure to read Configure RepoBee for the target organization (show-config and verify-settings) anyway! The rest of the guide assumes a configuration as described there.

Please open an issue and tag it with the docs tag for any bugs or missing information.

Contents:

• Introduction
  • Philosophy and goals
  • Key concepts
  • Conventions
  • Usage with GitHub Enterprise and github.com
• Install
  • Requirements
  • Check your Python version
  • Option 1: Install from PyPi with pip
  • Option 2: Clone the repo and the install with pip
• RepoBee User Guide
  • Getting started (the show-config, verify-settings and setup commands)
  • Updating student repositories (the update command)
  • Opening and Closing issues (the open-issues and close-issues commands)
  • Cloning Repos in Bulk (the clone command)
  • Peer review (assign-reviews and purge-review-teams commands)
  • Plugins for repobee
  • Migrate repositories into the target (or master) organization (migrate command)
  • Group assignments
• Configuration
  • OAUTH token
  • Configuration file
• CLI documentation
• repobee Module Reference
  • command
  • cli
  • config
  • exception
  • github_api
  • git
  • tuples
  • util
  • Core plugins
  • Extension plugins

Indices and tables

• Index
• Module Index
• Search Page