https://github.com/nirantak/wsiwn
What Should I Watch Next? Expert System built using Python/Flask and Prolog.
https://github.com/nirantak/wsiwn
expert-system flask prolog python python3 react swi-prolog web-scraping
Last synced: 5 months ago
JSON representation
What Should I Watch Next? Expert System built using Python/Flask and Prolog.
- Host: GitHub
- URL: https://github.com/nirantak/wsiwn
- Owner: nirantak
- Created: 2018-10-06T07:00:20.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2022-07-15T11:54:13.000Z (about 3 years ago)
- Last Synced: 2024-05-01T16:23:49.211Z (over 1 year ago)
- Topics: expert-system, flask, prolog, python, python3, react, swi-prolog, web-scraping
- Language: Prolog
- Homepage:
- Size: 305 KB
- Stars: 9
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# WSIWN
> *What Should I Watch Next?*
## Table of Contents
- [WSIWN](#wsiwn)
- [Table of Contents](#table-of-contents)
- [Usage](#usage)
- [Technology Stack](#technology-stack)
- [Working](#working)
- [REST API Endpoints](#rest-api-endpoints)
## Usage
- Install [Docker](https://hub.docker.com/search/?type=edition&offering=community) and [Docker Compose](https://docs.docker.com/compose/install/)
- Run web app
```shell
$ docker-compose up
```
or
- Run Prolog
```shell
$ docker-compose run api bash
$ swipl server/prolog/movies.pl
$ swipl server/prolog/tv.pl
```
Execute queries
```prolog
?- movies(X, Z).
?- movies(X, L, G, D, Y).
?- tv(X, Z).
?- tv(X, L, G, D, S, T).
```
where
- X: Output variable (byte string)
- Z: Input Search term (str)
- L: Language (str)
- G: Genre (str)
- D: Duration {short, avg, long}
- Y: Year (int)
- S: Number of Seasons (int)
- T: Status {ended, airing}
## Technology Stack
- Language - [Python3](https://www.python.org)
- Framework - [Flask](https://palletsprojects.com/p/flask/)
- Logic Programming - [SWI-Prolog](http://www.swi-prolog.org)
- Python - SWI-Prolog Bridge - [GitHub](https://github.com/yuce/pyswip), [SWIPL](http://www.swi-prolog.org/contrib/)
- DevOps - [Docker](https://www.docker.com/get-started)
## Working
- [Web Scraping](https://github.com/nirantak/wsiwn/blob/master/server/scripts/scraper.py) - Scrape a website to get top 100 movies and TV shows sorted by popularity. Results are here: [Movies](https://github.com/nirantak/wsiwn/blob/master/server/data/movies.txt), [TV Shows](https://github.com/nirantak/wsiwn/blob/master/server/data/tv.txt).
- [Fetch Data](https://github.com/nirantak/wsiwn/blob/master/server/scripts/seed_data.py#L15) - Fetch information from OMDB API about each record from previous step. Results are here: [Movies](https://github.com/nirantak/wsiwn/blob/master/server/data/movies.json), [TV Shows](https://github.com/nirantak/wsiwn/blob/master/server/data/tv.json).
- Write [Prolog Statements](https://github.com/nirantak/wsiwn/blob/master/server/scripts/seed_data.py#L49) - Write Prolog facts for each record from the previous step and add search queries. Results are here: [Movies](https://github.com/nirantak/wsiwn/blob/master/server/prolog/movies.pl), [TV Shows](https://github.com/nirantak/wsiwn/blob/master/server/prolog/tv.pl).
## REST API Endpoints
---
| Method[name] | URI | Description |
| ------------ | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- |
| GET[movies] | /api/movies?query=string | Display Movies matching query string |
| GET[tv] | /api/tv?query=string | Display TV shows matching query string |
| POST[movies] | /api/movies | Search Movies with params (at least 1): [language(str), genre(str), duration{short, avg, long}, year(int)] |
| POST[tv] | /api/tv | Search TV shows with params (at least 1): [language(str), genre(str), duration{short, avg, long}, seasons(int), status{airing, ended}] |