georgetown-cset / funder-finder

Retrieve GitHub repo funding information
Apache License 2.0
7 stars 3 forks source link

BUG: PYTHONPATH Can Bite New Users in Instructions #63

Open jspeed-meyers opened 1 year ago

jspeed-meyers commented 1 year ago

When @brackettsa was experimenting with funder-finder, she ran into a ModuleNotFoundError: No module named 'funderfinder' error.

I think when a new user naively follows the instructions on the README, they get to the below:

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

cd funderfinder
python get_funders.py --help

And will hit the ModuleNotFoundError: No module named 'funderfinder' error.

I think the solution is to change the python get_funders.py --help to PYTHONPATH='.' python3 funderfinder/get_funders.py.

There might need to be an explanation about PYTHONPATH too. Sorry this is a bad bug report. I don't entirely understand the problem, otherwise I'd write a better bug report :)