contributors-txt 1.0.2

Generate a list of contributors automatically from git data

contributors-txt

Generate a list of contributors automatically from git data.

Install

pip install contributors-txt

Usage

Run inside a git repository. Without an alias file, contributors are listed straight from git shortlog:

contributors-txt -o CONTRIBUTORS.txt

Pass an alias file to merge multiple emails under one name and assign teams:

contributors-txt -a aliases.json -o CONTRIBUTORS.txt

Add --no-bots to filter out GitHub Apps (dependabot[bot], pre-commit-ci[bot], github-actions[bot], Copilot, Claude, …):

contributors-txt --no-bots -a aliases.json -o CONTRIBUTORS.txt

If the output file already exists it is updated in place: missing emails are added and new contributors are inserted in commit-count order, preserving any manual edits.

Alias file

{
  "[e-mail]": {
    "mails": ["[e-mail]", "[e-mail]"],
    "name": "Pierre Sassoulas",
    "team": "Maintainers"
  }
}

Two helpers ship alongside the main command:

• contributors-txt-normalize-configuration -a aliases.json rewrites an alias file in the canonical sorted form.
• contributors-txt-extract-comment <CONTRIBUTORS.txt> -a aliases.json pulls free-text comments from an existing CONTRIBUTORS file back into the alias file.