https://github.com/prestashop/traces

Micro CLI application to get all GitHub contributors for a specified repository
https://github.com/prestashop/traces

github github-api hacktoberfest php tools

Last synced: 3 months ago
JSON representation

Micro CLI application to get all GitHub contributors for a specified repository

• Host: GitHub
• URL: https://github.com/prestashop/traces
• Owner: PrestaShop
• License: mit
• Created: 2016-12-02T13:49:19.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2024-05-22T15:44:58.000Z (7 months ago)
• Last Synced: 2024-05-22T16:33:58.244Z (7 months ago)
• Topics: github, github-api, hacktoberfest, php, tools
• Language: PHP
• Homepage:
• Size: 84 KB
• Stars: 7
• Watchers: 12
• Forks: 12
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Traces

Traces is a micro CLI application that is able to get all contributors and their contributions in "developer-readable" JSON format for a specified repository.

 

 

## Installation

 

The authentication is a basic login/password for GitHub.

> Note: If your Github login uses two-factor authentication, use an API token instead of password

 

```bash

 $ composer require prestashop/traces

 

 # Check a repository

 $ ./vendor/bin/traces -u  -p  -r  --config="config.yml"

 

 # Check an organization

 $ ./vendor/bin/traces -u  -p  -o  --config="config.yml"

```

A file named ``contributors.js`` will be generated, you can manipulate it using any programming language.

## Configuring

 

There are a number of settings that can be configured via the config file. Take a look at the `config.dist.yml` file for an example.

Option | Description

-------|-------------

exclusions | List of excluded users.

keepExcludedUsers | Set to `true` to flag excluded contributors instead of filtering them out from the output.

fieldsWhitelist | List of fields to keep from the API result. Leave blank if you want to keep them all.

extractEmailDomain | Set to `true` to extract the user's email domain and include it in the generated file

## License

This project is released under the MIT license.