St. Mary's Logistic

Description

Software application to help automate and digitise the St. Mary's Logistic.

Getting Started

Prerequisites

• Python 3.x (3.12.2 used)
• pip

Installation

1. Clone the repo

   git clone https://gitlab.griffin-studio.dev/st-marys/4004-database/assesment-2.git

2. Navigate to the project directory

   cd assesment-2

3. Create a virtual environment

   python -m venv venv

   or

   pyenv virtualenv stmarys-logistics

4. Activate the virtual environment

   source venv/bin/activate

   or (if using pyenv)

   pyenv activate stmarys-logistics
   
   # or
   
   . ./scripts/activate_pyenv.sh

   1. Deactivate the virtual environment

      source venv/bin/deactivate

      or (if using pyenv)

      pyenv deactivate
      
      # or
      
      . ./scripts/deactivate_pyenv.sh

5. Install required packages

   pip install -r requirements.txt

   1. Freeze package versions (optional)

      pip freeze > requirements.txt

6. Run Software

   python main.py

7. Test Software

   pytest

   if above fails try using:

   python -m pytest

Known issues

This section is dedicated to known issues for specific Operating Systems

Ubuntu 22.04 on (WSL for Windows)

Please be aware if you are using python on Ubuntu 22.04 on WSL for Windows you may encounter the following issues when running Python:

1. installed with pyenv:

   1. import _tkinter # If this fails your Python may not be configured for Tk

      if you see this error than it means your system is missing certain dependencies namely the tk driver to run the software. To install it either try apt install python3-tk or apt install tk-dev, then uninstall the version of python you run this project with pyenv uninstall <python ver> and reinstall it <pyenv> install <python ver>. That's because the python you are currently running is compiled from source and if module dependencies were missing during the compilation they wont be present in the compiled version.

License

Project made availible under GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007

Contact

Rihards Simanovics - rihards.s@griffin-web.studio