Welcome to repomate’s documentation!

If you are new to repomate, the Fundamentals and repomate 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.

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

Contents:

• Fundamentals
  • Philosophy and Goals
  • Terminology
  • Conventions
• Install
  • Requirements
  • Option 1: Install from PyPi with pip
  • Option 2: Clone the repo and the install with pip
• repomate User Guide
  • Getting Started (the verify-settings, migrate and setup commands)
  • Updating Student Repositories (the update command)
  • Opening and Closing issues (the open-issue and close-issue commands)
  • Cloning Repos in Bulk (the clone command)
• Configuration
  • REPOMATE_OAUTH Environment Variable
  • Configuration File
• repomate Module Reference
  • abstract_api_wrapper
  • command
  • cli
  • config
  • exception
  • github_api
  • git
  • pygithub_wrapper
  • tuples
  • util

Indices and tables

• Index
• Module Index
• Search Page