Metadata-Version: 2.1
Name: repomate
Version: 1.0.1
Summary: A CLI tool for managing large amounts of GitHub repositories
Home-page: https://github.com/slarse/repomate
Author: Simon Larsén
Author-email: slarse@kth.se
License: MIT
Download-URL: https://github.com/slarse/repomate/archive/v1.0.1.tar.gz
Description: # repomate
        [![Build Status](https://travis-ci.com/slarse/repomate.svg?token=1VKcbDz66bMbTdt1ebsN&branch=master)](https://travis-ci.com/slarse/repomate)
        [![Code Coverage](https://codecov.io/gh/slarse/repomate/branch/master/graph/badge.svg)](https://codecov.io/gh/slarse/repomate)
        [![Documentation Status](https://readthedocs.org/projects/repomate/badge/?version=latest)](http://repomate.readthedocs.io/en/latest/)
        [![PyPi Version](https://badge.fury.io/py/repomate.svg)](https://badge.fury.io/py/repomate)
        ![Supported Python Versions](https://img.shields.io/badge/python-3.5%2C%203.6%2C%203.7-blue.svg)
        ![Supported Platforms](https://img.shields.io/badge/platforms-Linux%2C%20macOS-blue.svg)
        [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
        
        ## Overview
        `repomate` is A CLI tool for administrating large amounts of GitHub
        repositories, geared towards teachers and GitHub Enterprise. `repomate` is
        currently being used for the introductory courses in computer science at
        [KTH Royal Technical Institute of Technology](https://www.kth.se/en/eecs). The
        courses have roughly 200 students and several thousands of repositories,
        allowing us to test `repomate` at quite a large scale.
        
        ### Getting started
        The best way to get started with `repomate` is to head over to the
        [Docs](https://repomate.readthedocs.io/en/latest/), where you (among other
        things) will find the
        [install instructions](https://repomate.readthedocs.io/en/latest/install.html)
        and
        [user guide](https://repomate.readthedocs.io/en/latest/userguide.html).
        
        
        ## Why `repomate`?
        `repomate` was developed at KTH Royal Technical Institute of Technology to help
        teachers and teaching assistants administrate GitHub repositories. It is
        inspired by the old
        [`teachers_pet` tool](https://github.com/education/teachers_pet), with added
        features and a user experience more to our liking. Features range from creating
        student repositories based on master (template) repos, to opening and closing
        issues in bulk, to assigning peer reviews and cloning repos in bulk. Some parts
        of `repomate` can be customized using a simple but powerful [plugin
        system](https://github.com/slarse/repomate-plug). For example, the
        [`repomate-junit4` plugin](https://github.com/slarse/repomate-junit4) allows for
        automatically running `JUnit4` test classes on production code in student repos.
        Below is the output from running `repomate -h`, giving brief descriptions of
        each of the main features:
        
        ```
        $ repomate -h
        usage: repomate [-h] [-v]
                        {show-config,setup,update,migrate,clone,open-issues,
                         close-issues,list-issues,assign-peer-reviews,
                         purge-peer-review-teams,check-peer-review-progress,
                         verify-settings}
                        ...
        
        A CLI tool for administering large amounts of git repositories on GitHub
        instances. See the full documentation at https://repomate.readthedocs.io
        
        positional arguments:
            {show-config,setup,update,migrate,clone,open-issues,
             close-issues,list-issues,assign-peer-reviews,
             purge-peer-review-teams,check-peer-review-progress,
             verify-settings}
        
            show-config         Show the configuration file
            setup               Setup student repos.
            update              Update existing student repos.
            migrate             Migrate master repositories into the target
                                organization.
            clone               Clone student repos.
            open-issues         Open issues in student repos.
            close-issues        Close issues in student repos.
            list-issues         List issues in student repos.
            assign-peer-reviews
                                Randomly assign students to peer review each others'
                                repos.
            purge-peer-review-teams
                                Remove all review teams associated with the specified
                                students and master repos.
            check-peer-review-progress
                                Fetch all peer review teams for the specified student
                                repos, and check which assigned reviews have been done
                                (i.e. which issues have been opened).
            verify-settings     Verify your settings, such as the base url and the
                                OAUTH token.
        
        optional arguments:
          -h, --help            show this help message and exit
          -v, --version         Display version info
        ```
        
        ## Roadmap
        As of December 17th 2018, repomate is a stable release. The currently available
        commands will remain available for the foreseeable future, and any deprecation
        will be announced at least one minor version ahead of a feature being removed.
        
        The plugin system is however still to be considered in the beta phase, as it
        has seen much less live action use. Features will however not be cut, as all
        of them are essential for the way I work personally.
        
        ## License
        This software is licensed under the MIT License. See the [LICENSE](LICENSE)
        file for specifics.
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Education
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX
Requires-Python: >=3.5
Description-Content-Type: text/markdown
Provides-Extra: TEST
