NZ COVID QR Sign Generator

This application will generate a QR code sign based on the design
used in NZ, which allows use of the NZ COVID Tracer app to manually
record our stops at different locations. This facilitates contact tracing
when locations of interest become known in your area.

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Road Map
5. License
6. Contact

About The Project

(back to top)

Built With

• Python
• tkinter
• qrcode
• Pillow

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

All instructions are based on Ubuntu 20.04.

Prerequisites

Step 1 — Setting Up Python 3

Ubuntu 20.04 and other versions of Debian Linux ship with Python 3 pre-installed. To make sure that our versions are up-to-date, let’s update and upgrade the system with the apt command to work with Ubuntu’s Advanced Packaging Tool:

sudo apt update
sudo apt -y upgrade

The -y flag will confirm that we are agreeing for all items to be installed, but depending on your version of Linux, you may need to confirm additional prompts as your system updates and upgrades.

Once the process is complete, we can check the version of Python 3 that is installed in the system by typing:

python3 -V

You’ll receive output in the terminal window that will let you know the version number. While this number may vary, the output will be similar to this:

Output
Python 3.8.10

To manage software packages for Python, let’s install pip, a tool that will install and manage programming packages we may want to use in our development projects. You can learn more about modules or packages that you can install with pip by reading “How To Import Modules in Python 3.”

sudo apt install -y python3-pip

Python packages can be installed by typing:

pip3 install package_name

For this project you'll need to install pygame.

pip3 install pygame

Also install the tkinter requirement to the system.

sudo apt install -y python3-tk

Installation

1. Clone the repo

   git clone https://github.com/fo3cus/covid_qr_generator.git

2. Install requirements packages

   pip3 install -r requirements.txt

(back to top)

Usage

Run main file from a terminal

cd <install_path>/covid_qr_generator/

python3 main.py

Fill in the fields of the form and click save to generate a PNG image file in the same directory as the application:

>

(back to top)

Roadmap

• Build and add releases
• Create wiki
  • Move prerequisites
  • Move installation
  • Move usage
• Tutorialise code comments

See the open issues for a full list of proposed features (and known issues).

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

James Rollinson - contact@rollinson.nz

Project Link: https://github.com/fo3cus/covid_qr_generator

(back to top)