Open Issue Finder

Find open issues fitting your programming interests. Hopefully, it helps to find an exciting project that needs help!

Screenshots

Usage

1. Fill out the config.ini with your interests. The interests and labels have some prepopulated to show you what it expects.
2. Requires only >=Python 3.x.x and no external dependencies!

python3 open-issue-finder

3. If no email credentials are supplied, projects are logged to stdout, and a .txt file is written with the name of open-issue-projects.txt. If email credentials are supplied, look in your email for a list of potential projects looking for contributors!

Run on a schedule

1. Make the script executable:

chmod +x open-issues-finder

2. Copy to the desired host location: Note: open-issues-finder and config.ini should be in the same directory. **Sys-Admins would place it in /usr/bin, but I prefer $HOME/.local/bin/. It comes down to preference.

cp open-issues-finder config.ini $HOME/.local

Cron job

---

The following is how I have it running on my VPS. It runs every day at 9 am.

0 9 * * * /usr/bin/python3.8 /home/vlad/.local/bin/open-issues-finder >/dev/null 2>&1

1. Get up to speed on what cron is
2. crontab guru - online crontab editor

Systemd service

---

1. Create the .service file in /etc/systemd/system. I'd name it something like potential-contributor.service

touch /etc/systemd/system/open-issues-finder.{service,timer}

2. Edit the .service file

vim -O open-issues-finder.service potential-contributor.timer

3. The contents would look like this.

/etc/systemd/system/potential-contributor.service

[Unit]
Description=Find projects with open issues and align with your programming interests.

[Service]
Type=oneshot
ExecStart=/usr/bin/open-issues-finder

[Install]
WantedBy=multi-user.target

/etc/systemd/system/open-issues-finder.timer

[Unit]
Description=Run open-issues-finder every 24 hours
Requires=potential-contributor.service

[Timer]
Unit=potential-contributor.service
OnUnitInactiveSec=24h
AccuracySec=1s

[Install]
WantedBy=timers.target

If your system is not playing nicely with ExecStart + absolute path or want it located elsewhere, then pass ExecStart a direct sh command.

ExecStart=/bin/sh -c "python3 /usr/bin/open-issues-finder"

4. Exit vim. I'll wait

5. Enable & start newly created service

systemctl enable --now open-issues-finder.service open-issues-finder.timer

---

TODO

• : Clean up edge cases around GitHub throttling
• : Allow for the file to keep growing so you can have a list of possible projects.
• : Add CLI options such as --help and --verbose

---

Author

It was created by Vlad Doster.

This project is hosted on GitHub. Please feel free to submit pull requests.

License

Copyright © 2019–2020 Vlad Doster. Released under the GPLv3 license, you can find it in the file LICENSE.