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.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| contributors_txt-1.1.3.tar.gz | 49.0 kB | Without provenance | Details for contributors_txt-1.1.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| contributors_txt-1.1.3-py3-none-any.whl | Python 3 | none | any | Details for contributors_txt-1.1.3-py3-none-any.whl |
Total release size: 66.0 kB
Release files / contributors_txt-1.1.3.tar.gz
| Download URL | contributors_txt-1.1.3.tar.gz |
|---|---|
| Size | 49.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3f5010cfa388e2740f84a69192a63eb444df54e9b6739323729751699886640c
|
|
BLAKE2b-256 checksum How to use checksums |
6edb04e0f4b6ac6d046ca9f6f59385adb45c116b6dde6f55a88ca88ecabf69c5
|
| 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.3-py3-none-any.whl
| Download URL | contributors_txt-1.1.3-py3-none-any.whl |
|---|---|
| Size | 17.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b762bb2426b2e9e4c6b3420ecd5ab1be303537968e7a97026e0057d297306bc5
|
|
BLAKE2b-256 checksum How to use checksums |
d1b43e2f90e585a90189edab107c0c5d9383bb77a7ac4d2efb704bef7a3c7676
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Security for contributors-txt 1.1.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.