Skip to content

Latest commit

 

History

History
66 lines (45 loc) · 1.52 KB

README.md

File metadata and controls

66 lines (45 loc) · 1.52 KB

WSIZ API

API for the WSIZ Virtual University website.

CodeFactor

Notice:

As I graduated WSIZ University now, unfortunately, I won't be able to maintain this project, as I do not have access to the Virtual University anymore. Feel free to fork this repository to continue maintaining it.

Requirements:

  • Python 3.6+

  • FastAPI framework

    $ pip install fastapi

  • BeautifulSoup library

    $ pip install beautifulsoup4

  • Uvicorn ASGI server

    $ pip install uvicorn

Installation:

$ git clone https://github.com/Teraskull/wsiz-api

$ cd wsiz-api

$ pip install -r requirements.txt

$ cd api

$ uvicorn main:app --reload

Documentation:

Open your browser at http://127.0.0.1:8000/docs.

You will see the automatic interactive API documentation (provided by Swagger UI).

License:

This software is available under the following licenses:

  • MIT