prestashop/traces

A simple CLI tool to generate information about GitHub contributors of a repository

v5.2.5 2024-05-23 07:01 UTC

Requires

• ext-json: *
• guzzlehttp/guzzle: ~6.0
• symfony/console: v3.2.0
• symfony/filesystem: v3.2.0
• symfony/yaml: v3.2.0

MIT

• PrestaShop SA

• prestashop
• contributors

README

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

 $ composer require prestashop/traces
 
 # Check a repository
 $ ./vendor/bin/traces -u <login> -p <password> -r <repositoryOwner/repositoryName> --config="config.yml"
 
 # Check an organization
 $ ./vendor/bin/traces -u <login> -p <password> -o <repositoryOwner> --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.

License

This project is released under the MIT license.