README.md

Funder Finder

This project allows you to retrieve funding information for a GitHub repository of interest to you. Current funding sources we support include:

• Open Collective
• Github Sponsors
• NumFOCUS
• Tidelift
• Google Summer of Code

We also have some general-purpose utilities.

See our issue list for funding sources we plan to retrieve in the future. We welcome your contributions!

How to use

Download the project and switch to the project directory:

git clone https://github.com/georgetown-cset/funder-finder
cd funder-finder

Install the dependencies:

pip install -r requirements.txt

Add a GitHub username and a GitHub API token as environment variables. For the API token, make sure to enable these scopes: admin:org, read:user, repo, user:email, and workflow.

export GITHUB_USERNAME=YOUR_GITHUB_USERNAME
export GITHUB_TOKEN=YOUR_GITHUB_TOKEN

Also add an Open Collective API key:

export OPENCOLLECTIVE_API_KEY=YOUR_OPENCOLLECTIVE_API_KEY

Change to funderfinder directory and run get_funders.py with the --help flag.

cd funderfinder
python get_funders.py --help

An example usage is:

PYTHONPATH='.' python3 funderfinder/get_funders.py georgetown-cset/funder-finder

How to contribute

Before getting started, please install the project dependencies and set up the pre-commit hooks:

pip install -r requirements.txt
pre-commit install

You can run the unit tests by running pytest from the root of the project directory. For all tests to pass, the user must add a GITHUB_TOKEN environment variable (see "How to use" section above).