{"id":16618676,"url":"https://github.com/gitcommitshow/open-community-kit","last_synced_at":"2025-03-16T22:30:36.668Z","repository":{"id":65556364,"uuid":"518532650","full_name":"gitcommitshow/open-community-kit","owner":"gitcommitshow","description":"Analyze and archive GitHub repo contributors","archived":false,"fork":false,"pushed_at":"2024-05-11T13:05:16.000Z","size":99,"stargazers_count":5,"open_issues_count":11,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-13T02:21:19.342Z","etag":null,"topics":["community-management","contributors","github-contributions","github-contributors","open-source-management","opensource","opensource-analytics","recognition"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gitcommitshow.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-07-27T16:25:15.000Z","updated_at":"2024-05-11T12:53:26.000Z","dependencies_parsed_at":"2023-12-14T21:28:32.392Z","dependency_job_id":"3e4c3c3a-16e4-4924-8b8e-a1085e2a5df2","html_url":"https://github.com/gitcommitshow/open-community-kit","commit_stats":{"total_commits":9,"total_committers":2,"mean_commits":4.5,"dds":0.4444444444444444,"last_synced_commit":"4ae95c9f3a6624c21f77e5ed072cc33eff0975ac"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitcommitshow%2Fopen-community-kit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitcommitshow%2Fopen-community-kit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitcommitshow%2Fopen-community-kit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitcommitshow%2Fopen-community-kit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gitcommitshow","download_url":"https://codeload.github.com/gitcommitshow/open-community-kit/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221668377,"owners_count":16860631,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["community-management","contributors","github-contributions","github-contributors","open-source-management","opensource","opensource-analytics","recognition"],"created_at":"2024-10-12T02:21:09.892Z","updated_at":"2024-10-27T11:25:31.839Z","avatar_url":"https://github.com/gitcommitshow.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# open-community-kit (ock)\nTools and stats for open-source communities\n\n[![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)\n\n## Installation\n\n```bash\nnpm install -g open-community-kit\n```\n\nYou can use `npx` as well if you just want to test a CLI command\n\n----\n\n## Usage\n\n### Leaderboard - GitHub Contributors \n\nFor all the repos of a user/org. Contributor with highest # of contributions at the top.\n\n**Using CLI**\n\nRun `open-community-kit yourGithubOrgName` from your terminal\n\nNote: You can also use the shorthand `ock` in place of `open-community-kit` i.e.\n\n```bash\nock yourGitHubOrgName\n```\n\nThis will\n* Fetch data from Github APIs and prepare a leaderboard of all the contributors to public repositories of your GitHub organization/user account\n* Save the leaderboard in a csv file in the same folder\n\nYou 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.\n\n```bash\nock yourGitHubOrgName yourGitHubPersonalToken\n```\n\n**Using code**\n\n```javascript\nimport OCK from 'open-community-kit';\nOCK.contributors.github.archive(\n    'your_github_org_or_username', \n    { \n        GITHUB_PERSONAL_TOKEN: 'your_gh_personal_token_optional'\n    }\n);\n```\n\n----\n\n## Settings for repeated usage\n\nIf 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\n\n```yaml\n# Set these variables in the environment to avoid repeatedly specifying these variables\n1. REPO_OWNER\n2. GITHUB_PERSONAL_TOKEN\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgitcommitshow%2Fopen-community-kit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgitcommitshow%2Fopen-community-kit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgitcommitshow%2Fopen-community-kit/lists"}