Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vladdoster/open-issues-finder

Find projects that align with your interests and have open issues!
https://github.com/vladdoster/open-issues-finder

easy first-project good linux open-source python

Last synced: 26 days ago
JSON representation

Find projects that align with your interests and have open issues!

Host: GitHub
URL: https://github.com/vladdoster/open-issues-finder
Owner: vladdoster
Created: 2020-01-10T23:21:55.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2023-01-12T02:03:13.000Z (almost 2 years ago)
Last Synced: 2023-03-05T22:06:56.718Z (over 1 year ago)
Topics: easy, first-project, good, linux, open-source, python
Language: Python
Homepage:
Size: 205 KB
Stars: 4
Watchers: 1
Forks: 0
Open Issues: 5
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Open Issue Finder

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

[![DeepSource](https://deepsource.io/gh/vladdoster/open-issues-finder.svg/?label=active+issues&show_trend=true)](https://deepsource.io/gh/vladdoster/open-issues-finder/?ref=repository-badge)

## Screenshots

## Usage

1. Fill out the [config.ini](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!

```bash
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:

```bash
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.

```bash
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.

```bash
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](https://wiki.archlinux.org/index.php/Cron)
2. [crontab guru - online crontab editor](https://crontab.guru/)

### Systemd service

----

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

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

2. Edit the `.service` file

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

3. The contents would look like this.

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

```bash
[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

```bash
[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.

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

4. Exit vim. I'll wait

5. Enable & start newly created service

```bash
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](http://vdoster.com).

This project is [hosted on GitHub](https://github.com/vladdoster/open-issues-finder). Please feel free to submit pull requests.

## License