<commit_before># GitHub Records Archiver

[![Build Status](https://travis-ci.org/benbalter/github-records-archiver.svg?branch=master)](https://travis-ci.org/benbalter/github-records-archiver) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

Backs up a GitHub organization's repositories and all their associated information for archival purposes.

## What it archives

* Git data (change history, tags, branches, etc.)
* Wikis (including change history)
* Issues and pull request (including comments, current state, etc.)
* Teams (including members and repository permissions)

## Requirements

1. Ruby
2. A GitHub [personal access token](https://github.com/settings/tokens/new) with `public_repo` and `repo` scope.

## Setup

1. `git clone https://github.com/benbalter/github-records-archiver`
2. `cd github-records-archiver`
3. `gem install bundler`
4. `bundle install`

## Usage

`bin/archive [ORGANIZATION]`<commit_msg>add gem badge<commit_after># GitHub Records Archiver

[![Build Status](https://travis-ci.org/benbalter/github-records-archiver.svg?branch=master)](https://travis-ci.org/benbalter/github-records-archiver) [![Gem Version](https://badge.fury.io/rb/github_records_archiver.svg)](http://badge.fury.io/rb/github_records_archiver) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

Backs up a GitHub organization's repositories and all their associated information for archival purposes.

## What it archives

* Git data (change history, tags, branches, etc.)
* Wikis (including change history)
* Issues and pull request (including comments, current state, etc.)
* Teams (including members and repository permissions)

## Requirements

1. Ruby
2. A GitHub [personal access token](https://github.com/settings/tokens/new) with `public_repo` and `repo` scope.

## Setup

1. `git clone https://github.com/benbalter/github-records-archiver`
2. `cd github-records-archiver`
3. `gem install bundler`
4. `bundle install`

## Usage

`bin/archive [ORGANIZATION]`
{'fraction_non_alphanumeric': 0.13812677388836328, 'fraction_numerical': 0.005676442762535478, 'mean_word_length': 5.409090909090909, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 11, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1605629', 'n_tokens_mistral': 689, 'n_tokens_neox': 656, 'n_words': 169}