Generate reports from amphibian info dataset
Project description
REPORT GENERATOR
Requirements
Python3 is required to be installed on the computer. Also, the python3 Venv package is required to be installed.
If Python3 is not available program can be ran by downloading executable files found in zipped in the dist_zip directory.
Further project requirements for external Python libraries can be found in the requirements.txt file. This file is located in the root folder of the project directory.
The rest of the process of the project's setup is outlined in the installation section below.
Installation
Installation from PyPI
Installation from Git Repository
To install the project: first download the project code from the repository. Extract or pull the code into the directory of your choice. Open a terminal in this directory.
Next set up the virtual environment. This allows us to install the project's libraries without affecting the broader Python environment on the computer. (In example code Python's venv is used.)
python3 -m venv {venv-name}
This will create a virtual environment to install the project's required libraries. We then activate it through the following command:
source {venv-name}/bin/activate
We then install the required files:
pip install requirements.txt
Then install package:
pip install requirements.txt
When this process has been completed it is now possible to use the program.
Installation from executable files
Download the file. Unzip file. Open directory and double-click app file.
Use
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 user wants to use the CLI:
report-generator --cli [options]
CLI options can be found with the command:
report-generator -h
report-generator -help
Or can be found in the projects documentation.
If the user wants to set up a new project:
create-report-generator
Documentation
Project documentation can be found here
Versions
Archived versions of the Report Generator Program can be found in links to repositories below
Changelog
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for qub-amphibian-report-generator-0.0.22.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e28b4d8b71ece28ab1c452e504a9976ac033b2ef046ef23159dacd5c57568329 |
|
MD5 | e7cfd638dec35a795ea73de3e3dda6f9 |
|
BLAKE2b-256 | 1d9f2374efac70b804bdf8d13d28fe5434df15c2f4de74f198cbca88149025a8 |
Hashes for qub_amphibian_report_generator-0.0.22-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b03076cc30334be308029ee4bdaba691ca6ee4178165f8f5d3d213691ce7c430 |
|
MD5 | 94ed0db5c8352d5bc0cadd818a423d2e |
|
BLAKE2b-256 | 1802b446ba04db34c0dc01929fcfcc36e94132688e2af61420128873b0370a09 |