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
{
"pierre.sassoulas@gmail.com": {
"mails": ["pierre.sassoulas@gmail.com", "pierre.sassoulas@elum-energy.com"],
"name": "Pierre Sassoulas",
"team": "Maintainers"
}
}
Two helpers ship alongside the main command:
contributors-txt-normalize-configuration -a aliases.jsonrewrites an alias file in the canonical sorted form.contributors-txt-extract-comment <CONTRIBUTORS.txt> -a aliases.jsonpulls free-text comments from an existing CONTRIBUTORS file back into the alias file.
Metadata
Release files for contributors-txt 1.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| contributors_txt-1.1.1.tar.gz | 48.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| contributors_txt-1.1.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 64.9 kB
Release files / contributors_txt-1.1.1.tar.gz
| Download URL | contributors_txt-1.1.1.tar.gz |
|---|---|
| Size | 48.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5c8586c3e6eef17140daef6194b22f5cbd3e80027de25f572a57885dc912c3c6
|
|
BLAKE2b-256 checksum How to use checksums |
857af4d1914e874bbd6a2be20537c53da61dbda38bafe2831f1896f930d6f90c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Release files / contributors_txt-1.1.1-py3-none-any.whl
| Download URL | contributors_txt-1.1.1-py3-none-any.whl |
|---|---|
| Size | 16.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
068c2116d8563d42d6d0cfa1621683dcbda084d85cf5b11a1efeb1dd6f0a6360
|
|
BLAKE2b-256 checksum How to use checksums |
b8d8e5af57daaa9f599f98c28574c72236e5cff3f79aaca3b4f1b108ebb66f3e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
