Tutorial - Installation and Usage

Requirements

Python3 installation is required. The Python3 Venv package is recommended.

If Python3 is not available - the project can be run by downloading the executables folder that matches the OS that your computer uses. The project can be started by opening the report-generator file.

Installation

Installation from PyPI

To install from PyPI and using pip it is recommended to initially set up a virtual environment or use a package manager like poetry.

Create Venv

    python3 -m venv {venv-name}

Activate Venv

Then activate the venv.

    source {venv-name}/bin/activate

Install package

Then install the package.

    pip install qub-amphibian-report-generator

Use

GUI

Once the package has been installed and setup the Report Generator program can be used from venv with the command:

    report-generator

This will start the GUI application for the report generator. If the report-generator command has not been run before it will begin the project setup process.

Project Setup

The user will need to enter some project settings information:

The process will download relevant data files and create and insert data into project databases:

Create Report

This will then allow the user to run the report generator again and produce the outputted pdf file.

CLI

If the user wants to use the CLI:

    report-generator --cli [options]

CLI default report

CLI filtered report

CLI options

CLI options can be found with the command:

    report-generator -h
    report-generator -help

Or can be found in the projects documentation.

New Project with CLI

If the user wants to set up a new project:

    create-report-generator