afk/ib-clearance
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Properly document the damn thing.

Browse Source
This commit is contained in:
Abdulkadir Furkan Şanlı
2019-01-11 15:06:35 +01:00
parent 42e6042405
commit 4e05e3380a
3 changed files with 39 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -2,15 +2,15 @@
ib-clearance is a program which helps schools manage the entrance and exiting of their IB Diploma Program students. Due to the unique nature of IB students' timetables, the program helps to automatically check individual timetables and give clearance to students who have finished for the day.
## Building
## Building & running
The code is currently designed to run on Python 3.6.*.
The code is currently designed to run on Python 3.6.* and requires the [`getch`](https://pypi.org/project/getch/) module on platforms other than Windows.
Binaries can be built using the `pyinstaller` package (`pyinstaller --onefile ib-clearance.py`).
Binaries can be built using [`pyinstaller`](https://pypi.org/project/PyInstaller/): `pyinstaller --onefile ib-clearance.py`
## Database specification
The program requires a SQLite database `database.db` in the working directory, containing data for all classes.
The program requires a SQLite database `database.db` in the working directory, containing data for all school classes.
`database.db` must contain: