tributors 0.0.0

give tribute to your repository contributors.

tributors

What is tributors?

Tributors is a Python library and GitHub action that helps you to pay tribute to your contributors. Tribute interacts with several well-known repository metadata files:

• all-contributors
• Zenodo
• CodeMeta under development

Each of the services above allows you to generate some kind of metadata file that has one or more repository contributors. This file typically needs to be generated and updated manually, and this is where tributors comes in to help! Tributors will allow you to programatically create and update these files. By way of using a shared cache, a .tributors file that can store common identifiers, it becomes easy to update several of these metadata files at once. You can set criteria such as a threshold for contributions to add a contributor, export an Orcid ID token to ensure that you have Orcid Ids where needed, or use an interactive mode to make decisions as you go.

How does it work?

Tributors uses the following sources of information to update your contributor files.

GitHub API

Since these files are served in GitHub repositories, it's fairly easy to retrieve repository contributors using the GitHub API in both cases.

Orcid

Given that you provide an Orcid token, we can find Orcid records based on email addresses.

Zenodo

Zenodo also has a rest API that can be used to create an initial .zenodo.json for a repository.

The GitHub Action details are included below. See the docs for more detailed usage, both on your local machine, and via a Docker container.

GitHub Action

Since all-contributors requires node, you might find it easiest to interact with the tool via a GitHub action. You can see examples in the examples folder.

Inputs

name	description	required	default
zenodo_file	.zenodo.json to update. If does not exist, must define zenodo_doi	false	.zenodo.json
zenodo_doi	Zenodo DOI needed for init. Leave unset to skip init.	false	unset
log_level	Log level to use, one of INFO, DEBUG, CRITICAL, ERROR, WARNING, FATAL (default INFO)	false	INFO
threshold	the minimum number of contributions required to add a user	false	1
force	if files exist, force overwrit	false	false
ctype	Contribution type, which defaults to "code" if not set.	false	code
skip_generate	skip running all-contributors generate	false	false

If you aren't familiar with all-contributors, you'll need to add some commenting in your repository README so the client knows where to write.

Contributors

@vsoch TODO

• GitHub action needs to be refactored for new client
• Docker image build example needs refactor too
• Orcid API needs to be added to get ORCIDids based on emails
• an example should be added to push to a repository / open PR