The creation of this application was inspired by the loss of sibbell.com
This was developed under Python 3.7.
The application works by checking the API for a supported source and comparing the latest release information to what has been stored. If the API contains a newer release, a notification is created and storage is updated.
In practical usage, storage and notifications are handled separately, with the exception of github --user. The --add and --remove arguments are used in conjunction with most sources in order to manage which pieces of software are in storage. Executing the program with only a source argument, such as relm.py github, will check for updates for software in storage.
github --user behaves differently since the data-set is remotely managed. When run, it compares storage to what the GitHub API says the user has starred. Any repos found in storage but not in the API response are removed from storage. Any repos found in the API response but missing from storage are added to storage. It then iterates over the contents of storage and makes a request for each repo.
I only support monitoring for repos that follow proper Releases/Tags conventions. Relm will first check for entries under Releases, and if there are none it will fall back to Tags. If there are no entries under Releases or Tags, then there is nothing to be tracked. If you wish to follow a repo where the owner commits new versions without creating Releases or Tags, you should open a dialogue with them about their process and encourage them to use Releases.
./config.ini is created with default & placeholder values if it does not exist.
./email.template is created if it does not exist.
- GitHub
- All public repositories
- A users starred repos
- Mozilla
- Firefox
- Thunderbird
- file
- requests (I intend to do away with this in a future release)
I am open to feature requests for new sources, storages, and notifications, and any other ideas users may have. Please submit an issue with the label 'enhancement' to make a request. For new sources, I'm much more likely to add it in a timely manner if you can provide me with details about the API in question.
To add a repo to storage
python3 relm.py github --add=docker/docker-ce
To remove a repo from storage
python3 relm.py github --remove=docker/docker-ce
python3 relm.py github --user=jekotia
To add a product to storage
python3 relm.py mozilla --add=firefox
To remove a product from storage
python3 relm.py mozilla --remove=thunderbird
Release checking is intended to be run at regular intervals utilising a scheduler, such as cron.
python3 relm.py all
python3 relm.py github
python3 relm.py github --user=jekotia
python3 relm.py mozilla