Generate reports from amphibian info dataset
Project description
REPORT GENERATOR
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
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.34.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 98302f11c77c799c9f5b6c763dcdee830c37eaf9f45b47cfe1f6dbbaff1d296c |
|
MD5 | 5a830d8ad428d4c16d4e730760e2c591 |
|
BLAKE2b-256 | fc86efd491ae59994f6f5e79ec158c810c1faf509231eb58fa0426caec9e6123 |
Hashes for qub_amphibian_report_generator-0.0.34-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f97c4447b3310a5a6b320ddeaa9a6aa10b16cb3a89509f78535d1fc7fed8aaf6 |
|
MD5 | 807b84b17ea0476d56c6b3b73151ec64 |
|
BLAKE2b-256 | f00d7c4b69b1a80db792abada31be4fc580384bf463c847fdb87d22c66a7f123 |