Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/y-pakorn/cutimetable-api

Chulalongkorn University aka Chula course API from web scrapping
https://github.com/y-pakorn/cutimetable-api

Last synced: about 1 month ago
JSON representation

Chulalongkorn University aka Chula course API from web scrapping

Awesome Lists containing this project

README

        

# CU Course Timetable API


Header


Chulalongkorn university course API from web scrapping.



Software License
Actions
Doc
Gitter

## About the project

Since Chula doesn't have the API for student developer to directly use, I managed to create course API for whoever want to use!

Built using flask for web API framework, request and bs4 for web scraping.

Used in [CU Course Timetable](https://apps.apple.com/ag/app/chula-class-timetable/id1527905632) application! (iOS Only)

## Documentation

It's on [SwaggerHub](https://app.swaggerhub.com/apis-docs/y-pakorn/cutimetable-api/1.0.0)!

## Getting Started

### Prerequisites
- Python 3.8
- pip

### Installation

1. Clone the repo
```
git clone https://github.com/y-pakorn/cutimetable-api.git
```
2. Install dependencies
```
cd cutimetable-api
```
```
pip install -r requirements.txt
```

### Usage

Simply ```python3 run.py``` and the app will be served at https://localhost:5000/cutimetable/v1/ (Refer to docs for API path)

### Example

Example json output of the API

![Json output](https://i.imgur.com/QkDFeFQ.png)

## Contributing

Any contributions you make are **greatly appreciated**.

Please open an issue or open a pull request!

## License

MIT