https://github.com/gitcommitshow/open-community-kit

Analyze and archive GitHub repo contributors
https://github.com/gitcommitshow/open-community-kit

community-management contributors github-contributions github-contributors open-source-management opensource opensource-analytics recognition

Last synced: 11 days ago
JSON representation

Analyze and archive GitHub repo contributors

• Host: GitHub
• URL: https://github.com/gitcommitshow/open-community-kit
• Owner: gitcommitshow
• License: mit
• Created: 2022-07-27T16:25:15.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-11T13:05:16.000Z (6 months ago)
• Last Synced: 2024-10-13T02:21:19.342Z (25 days ago)
• Topics: community-management, contributors, github-contributions, github-contributors, open-source-management, opensource, opensource-analytics, recognition
• Language: JavaScript
• Homepage:
• Size: 96.7 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# open-community-kit (ock)

Tools and stats for open-source communities

[![test](https://github.com/gitcommitshow/open-community-kit/actions/workflows/test.yml/badge.svg)](https://github.com/gitcommitshow/open-community-kit/actions/workflows/test.yml)

## Installation

```bash

npm install -g open-community-kit

```

You can use `npx` as well if you just want to test a CLI command

----

## Usage

### Leaderboard - GitHub Contributors 

For all the repos of a user/org. Contributor with highest # of contributions at the top.

**Using CLI**

Run `open-community-kit yourGithubOrgName` from your terminal

Note: You can also use the shorthand `ock` in place of `open-community-kit` i.e.

```bash

ock yourGitHubOrgName

```

This will

* Fetch data from Github APIs and prepare a leaderboard of all the contributors to public repositories of your GitHub organization/user account

* Save the leaderboard in a csv file in the same folder

You will hit the API limits soon. **To increase API limits**, add [`GITHUB_PERSONAL_TOKEN`](https://github.com/settings/tokens) as well in the arguments i.e.

```bash

ock yourGitHubOrgName yourGitHubPersonalToken

```

**Using code**

```javascript

import OCK from 'open-community-kit';

OCK.contributors.github.archive(

    'your_github_org_or_username', 

    { 

        GITHUB_PERSONAL_TOKEN: 'your_gh_personal_token_optional'

    }

);

```

----

## Settings for repeated usage

If you are going to use this command frequently, you might not want to set organization name and personal token again and again. Instead, you can set following environment variables and then you don't need to pass those variables as CLI arguments or function parameters

```yaml

# Set these variables in the environment to avoid repeatedly specifying these variables

1. REPO_OWNER

2. GITHUB_PERSONAL_TOKEN

```