Skip to main content

ucheck library

Project description

ucheck

pypiv pypipv

Autosubmit your UCheck COVID-19 self-assessment form

Disclaimer

  • ucheck automatically completes the University of Tornto's UCheck COVID-19 self-assessment form as follows:
    • YES: "Do any of the following statements apply to you? - I am fully vaccinated against COVID-19."
    • NO: "In the last 5 days, have you experienced any of these symptoms that are new, worsening, and not related to other known causes or conditions you already have?"
    • NO: "Do any of the following apply? - You live with someone who is currently isolating because of a positive COVID-19 test."
    • NO: "In the last 14 days, have you travelled outside of Canada and been told to quarantine per the federal quarantine requirements?"
    • NO: "Has a doctor, health care provider, or public health unit told you that you should currently be isolating (staying at home)?"
    • NO: "In the last 5 days, have you tested positive for COVID-19?"
  • If you do not satisfy these questions as listed, DO NOT use this library to complete your UCheck form. If you're interested in making these choices customizable, please raise an issue using the issues tracker.

Installation

pip install ucheck

Requirements and setup

This library uses Selenium to complete the UCheck form. If you're new to Selenium, it takes ~5 minutes to download and set up your browser driver. View how to download and configure a browser driver. If you're on macOS and hit permission issues, check out this Stackoverflow article.

ucheck is simple to use

import os
import time

from selenium.webdriver import Chrome
from selenium.webdriver.chrome.service import Service
from ucheck import UCheck

if __name__ == "__main__":
    # E.g., Save UTORid login and password as environment variables.
    utorid_login = os.environ["UTORID_USER"]
    utorid_pass = os.environ["UTORID_PASS"]
    with UCheck(Chrome, Service, driver_path="/opt/WebDriver/bin/chromedriver") as ucheck:
        ucheck.complete_ucheck(utorid_login, utorid_pass)
        # Briefly keep browser window open before closing.
        time.sleep(5)

Set up a Cron job to execute ucheck

Here's an option to fully automate your Ucheck form submission. If you're on a *NIX computer, add the following lines to your cron configuration file:

SHELL=/bin/bash
0 8 * * * source /path/to/ucheck_script/venv/bin/activate && DISPLAY=:0 python /path/to/ucheck_script/main.py

What the Cron job is doing:

  1. Everyday at 8 am
  2. Activate virtual environment to execute ucheck_script/main.py
  3. Execute ucheck_script/main.py, where main.py is the demo Python script posted above

You can find more information about setting up a Cron job here.

Exceptions

Valid UTORid credentials are required to complete your UCheck form.

import os

from selenium.webdriver import Chrome
from selenium.webdriver.chrome.service import Service
from ucheck import UCheck
from ucheck.exceptions import InvalidUTORidLogin

if __name__ == "__main__":
    # Set invalid user login credentials.
    utorid_login = "invalid-login"
    utorid_pass = os.environ["UTORID_PASS"]
    with UCheck(Chrome, Service, driver_path="/opt/WebDriver/bin/chromedriver") as ucheck:
        try:
            ucheck.complete_ucheck(utorid_login, utorid_pass)
        except InvalidUTORidLogin as e:
            print(e)

Contribute

Support

If you are having issues or would like to propose a new feature, please use the issues tracker.

License

The project is licensed under the MIT license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ucheck-0.0.6.tar.gz (1.1 MB view hashes)

Uploaded Source

Built Distribution

ucheck-0.0.6-py3-none-any.whl (6.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page