Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
multi-commit squash
  • Loading branch information
Alistair-Mitchell authored and domRG committed Apr 4, 2023
1 parent 6ad521d commit b91aca7
Showing 1 changed file with 20 additions and 15 deletions.
35 changes: 20 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,50 @@
# PrintSubmissionApp
*Version Control for 3d print queue app development*

App to submit and order the 3d printing queue, streamline the whole affair. To run, make sure you have all the prerequisites and then run mainapp.py
App to submit and order the 3d printing queue, this was created in 2018 to replace a paper spreadsheet and streamline the whole affair.

**As copied from the main app:**
**As copied from the old sign-in app:**

The app: It's written in Python using QT for GUI stuff and Google Sheets for a backend. This keeps data accessible in an easy spreadsheet format for any data analysis people might want to do about the userbase.

**To build:**

You'll need Python 3 (I use 3.7 at the moment) and will need to get some dependencies from pip. These are modules used to access the Google Sheets API, create QT GUIs and authenticate etc..: PYQT5, Gspread, Oauth2client,cython and google-api-python-client
You'll need Python 3 and will need to get some dependencies from pip. These are modules used to access the Google Sheets API, create QT GUIs and authenticate etc.

use `pip3 install pyqt5 gspread oauth2client cython google-api-python-client ldap3` to install prerequisites
To run, make sure you have all the prerequisites. Use the requirements file and your IDE to achieve this.
When up to date and ready run main.py.

*Features:*

Automatic formatting of print queue
Google drive upload (Can now specify which folder!!!)
Google drive upload
GUI
Tells user position in queue after print upload
Only allows supported printers
Passive agressive when print is over 10 hours
Features can be toggled in Config file
Passive agressive when print is over 10 hours
Checks for valid emails and full names
Interfaces with kiosk system

*Quirks:*

Badly written code
Does not adhere to PEP 8
Registration involves copying from LDAP


*Issues:*

LDAP required even at beginner level
App size updates are broken
Colour scheme for rep box is wrong
Putting prints on wrong sheet
Suggests last few names of users and fills respective details (broken)
Poor compatibility for non 1080p devices


*Planned features:*

ETA of print time, eg your print will be ready within X time
I would like the same logging system as the login app implemented when a rep signs a print off, tried but failed to implement
Interface with print running program (yet to be developed)
I would like the same logging system as the login app implemented when a rep signs a print off, tried but failed to implement

*Contributors:*

Alistair Mitchell - Initial creation of program (2018) and writer of base code to achieve all functionality up to 2021 with majority still valid in 2022.
Sam Rhodes - Minor visual changes (2020)
Harry Merckel & Dom Rugg-Gunn - Contribution of better coding practice and rewrite of some modules to use better techniques. Adjusted code to interface better with kiosk system (2022)
Sam Piper & CT - Minor updates and changes as well as stewardship (2023)
Eromu Ehwerhemepha - Present individual handling development

0 comments on commit b91aca7

Please sign in to comment.