fsp_scripts/README.md

72 lines
1.6 KiB
Markdown

# Flight Schedule Pro Scripts
## Disclaimer
Expect this shit to break at any point. Most likely when you really need it.
Examples assume a UNIX-like environment
## Requirements
- Python 3
- Pip
- Firefox
## Install
Clone this repository
Navigate to the resulting directory
Create a virtual environment and install dependencies
### UNIX-Like
```bash
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
```
### Windows
```bat
py -m venv .venv
.venv\Scripts\activate
pip install -r requirements.txt
```
Update config.ini with your Flight Schedule Pro tenant ID, username, and password
Tenant ID is the ID of the company that the user wishes to log in to
This can be found in the login URL
![Finding Tenant ID](/documentation/tenant_id.png "Tenant ID")
## Config
TODO (aka figure it out yourself)
## Scripts
### save_progress_reports.py
Downloads individual session PDFs for students and merges them into a single PDF per student
#### Usage
```bash
# At a minimum the script requires one argument, the name of a student to retrieve sessions for
python save_progress_reports.py "Greg Johnson"
# Also accepts multiple students (one PDF generated per student)
python save_progress_reports.py "Greg Johnson" "Casey Serbagi"
# Partial names work as well (retrieves the first student with a matching name)
python save_progress_reports.py Greg
# List students
python save_progress_reports.py -l
# Output PDF(s) to another directory
python save_progress_reports.py -o /my/shitty/directory Greg
# More usage details
python save_progress_reports.py --help
```