IRCC Citizenship Portal Update Checker

This project contains a Python script (check_ircc_updates.py) that checks for updates on the IRCC (Immigration, Refugees and Citizenship Canada) portal and sends a notification if there is an update. The script is designed to be run constantly in the background. It checks for updates at a specified interval, and if there is an update, it sends a notification via email and/or push. Note that push notifications setup isn't functional yet, I'm still working on it.

Requirements

This script requires Python 3.7 or above. Some but not all necessary dependencies are listed in the requirements.txt file. You can install these dependencies using pip or Conda:

pip install -r requirements.txt

Usage

1. Clone this repository to your local machine:

git clone https://github.com/yourusername/ircc-citizenship.git

2. Install the necessary Python dependencies (see above).

3. Rename config_private.example.json to config_private.json.

4. Modify config_private.json to include your personal information:

{
  "ircc_account": {
    "username": "<YOUR_IRCC_USERNAME>",
    "password": "<YOUR_IRCC_PASSWORD>"
  },
  "email": {
    "sender": "<SENDER_EMAIL_ADDRESS>",
    "password": "<SENDER_EMAIL_PASSWORD>",
    "receiver": "<RECEIVER_EMAIL_ADDRESS>"
  },
  "pushover": {
    "api_token": "<PUSHOVER_API_TOKEN>",
    "user_key": "<PUSHOVER_USER_KEY>"
  }
}

5. Run the script:

python check_ircc_updates.py

You can also run the script in the background:

nohup python -u check_ircc_updates.py > output.log &

Or in a screen session:

python -u check_ircc_updates.py | tee output.log

6. To stop the script, first find the process ID (PID) using this command:

ps aux | grep 'check_ircc_updates.py' | grep -v grep

Then kill the process using the PID:

kill -9 <PID>

How it Works

When run, check_ircc_updates.py uses Selenium WebDriver to log in to the IRCC portal, check for updates, take a screenshot, and send a notification if there is an update. The script logs in using the username and password specified in config_private.json, and it sends notifications using the email and Pushover credentials specified in config_private.json.

The script also generates several files:

• output.log contains the script's console output.
• last_updated.txt contains the date and time of the last update.
• screenshots/ contains screenshots of the IRCC portal.

These files are not tracked by Git.

Purging Screenshots

The purge_screenshots.py script can be used to remove old screenshots from the screenshots/ directory.

Note on Selenium WebDriver

This script uses the Safari WebDriver by default, but you can use any WebDriver by specifying it in config_public.json. You can download the WebDriver for your browser from the Selenium downloads page.

Please ensure that the WebDriver binary is in the PATH of your operating system. As of Selenium 4.6.0, the Selenium bindings will automatically configure the browser drivers for Chrome, Firefox, and Edge if they are not present on the PATH using Selenium Manager.

---