documentation
This commit is contained in:
parent
26104ecce3
commit
9ea0fc7960
19
README.md
19
README.md
@ -1,5 +1,9 @@
|
|||||||
# Flight Schedule Pro Scripts
|
# Flight Schedule Pro Scripts
|
||||||
|
|
||||||
|
## Disclaimer
|
||||||
|
|
||||||
|
Expect this shit to break at any point. Most likely when you really need it.
|
||||||
|
|
||||||
## Requirement
|
## Requirement
|
||||||
Python 3
|
Python 3
|
||||||
Pip
|
Pip
|
||||||
@ -8,14 +12,16 @@ Firefox
|
|||||||
## Install
|
## Install
|
||||||
|
|
||||||
Clone this repository
|
Clone this repository
|
||||||
|
|
||||||
|
Navigate to the resulting directory
|
||||||
|
|
||||||
|
Create a virtual environment and install dependencies
|
||||||
```bash
|
```bash
|
||||||
#navigate to the folder
|
python -m venv .venv
|
||||||
cd fsp_scripts
|
|
||||||
#create a virtual environment and install dependencies
|
|
||||||
python -m vene .venv
|
|
||||||
source .venv/bin/activate
|
source .venv/bin/activate
|
||||||
pip install -r requirements.txt
|
pip install -r requirements.txt
|
||||||
```
|
```
|
||||||
|
|
||||||
Update config.ini with you Flight Schedule Pro username and password
|
Update config.ini with you Flight Schedule Pro username and password
|
||||||
|
|
||||||
## Config
|
## Config
|
||||||
@ -38,9 +44,12 @@ python save_progress_reports.py "Greg Johnson"
|
|||||||
# Also accepts multiple students
|
# Also accepts multiple students
|
||||||
python save_progress_reports.py "Greg Johnson" "Casey Serbagi"
|
python save_progress_reports.py "Greg Johnson" "Casey Serbagi"
|
||||||
|
|
||||||
#Partial names work as well (retrieves the first matching student name found)
|
# Partial names work as well (retrieves the first student with a matching name)
|
||||||
python save_progress_reports.py Greg
|
python save_progress_reports.py Greg
|
||||||
|
|
||||||
|
# List students
|
||||||
|
python save_progress_reports.py -l
|
||||||
|
|
||||||
# More usage details
|
# More usage details
|
||||||
python save_progress_reports.py --help
|
python save_progress_reports.py --help
|
||||||
```
|
```
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user