Skip to content

Latest commit

 

History

History
56 lines (37 loc) · 1.65 KB

README.md

File metadata and controls

56 lines (37 loc) · 1.65 KB
Raw

Courses API

Courses API is a tool to scrape course information from the University of Adelaide website and provide course data to other CS Club Open Source Team projects via an API endpoint.

Getting Started

To get started, please follow these steps:

  1. Install uv if not already installed:

    Linux, macOS, Windows (WSL)

    curl -LsSf https://astral.sh/uv/install.sh | sh

    Windows (Powershell)

    powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

  2. Install dependencies:

    uv sync
pre-commit install

  3. Make a .env file and copy .env.example into it

Running the API Server

  1. Start the FastAPI server:

    uv run fastapi dev src/server.py

  2. Open http://localhost:8000/docs with your browser to see the API documentation and to test the available endpoints.

Running the scraper

Start the scraper (Note: Scraping all the courses may take over an hour):

uv run python3 src/scraper.py

Debugging

The output level of the logger can be configured in the .env. Set DEFAULT_LOGGING_LEVEL to your desires level such as DEBUG and ERROR. DEBUG outputs all logs into a file, including errors. ERROR only logs errors into a log file.

Contributing

We welcome contributions to enhance Courses API! If you find any issues, have suggestions, or want to request a feature, please follow our Contributing Guidelines.

License

This project is licensed under the MIT License. See LICENSE for details.