Introduction

The most common use APIs for AHU. Made with ❤ by @lolimay, @WesteryCN and @JOHNYXUU.

Development

Prerequisites

Please ensure that you have installed following stuff before officially starting your development:

• pip >= 19.0.3
• python3 >= 3.6.5
• Node.js >= 11.12.0
• npm >= 6.9.0
• VS Code >= 1.33.1 (Recommended)
• VS Code Extension: Python (Recommended)

Fetch the source code

git clone git@github.com:curdbin/AHU-API.git

Install dependencies

cd AHU-API
npm install # install node dependencies

Local install

We strongly recommend you to install python3 dependencies locally by using virtualenv:

virtualenv venv -p python3
source venv/bin/activate
pip install -r requirements.txt

Global install

Or you can just install python3 dependencies globally by following command:

pip install -r requirements.txt # add `sudo` prefix if permission denied

Configure your password

cd src
cp auth.example.ini auth.ini # Only for linux, use RENAME in windows instead.

Copy auth.example.ini to auth.ini，and write your student number and password into this file.

Run

Linux

python3 main.py

Windows

python.exe main.py

Architecture

.
|_ docs
|_ archives
|_ src

References

1. http://zf.ahu.cn
2. http://portal.ahu.edu.cn

LICENSE

The project is open sourced under the MIT License.

Contributors