Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/tglide/netflix-letterboxd-api

API for storing Netflix movies catalogue and viewing letterboxd info
https://github.com/tglide/netflix-letterboxd-api

Last synced: about 2 months ago
JSON representation

API for storing Netflix movies catalogue and viewing letterboxd info

Awesome Lists containing this project

README

        

# Netflix Letterboxd API
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge)](http://commitizen.github.io/cz-cli/)

## Description

This is an API for storing the catalogue of Netflix Movies and getting movies from Letterboxd Lists

Based on https://github.com/cosmic-byte/flask-restplus-boilerplate.

## Installation

- Clone/Download this repo
- Make sure you have the latest version of `Python 3` and `PostgreSQL` installed.
- (Optional) Create a virtual environment on the root of the project
- Install the requirements with `pip install -r requirements .txt`
- Create a new database on `PostgreSQL`
- Copy the contents of `.env.example` onto a new `.env` file, replacing the contents between `{}` with the needed information
- Run the following commands to initialize the DB:
- `python manage.py db init`
- `python manage.py db migrate`
- `python manage.py db upgrade`
- Run `python manage.py db run`

That's it!

If you want to populate the database with movies:
- Create an user
- Give it admin status by editing the admin value on `PgAdmin4`
- Log in and get the Auth Token
- Replace it in the `.env` file
- Run `search.py`

## Contributing

Contributors are welcome! As this is a commitizen friendly repo, please follow this instructions when committing:

- Make sure you have `yarn` installed
- Run `yarn`
- Run `yarn global add commitizen`
- For every commit, run `git cz` instead of `git commit`

## License

This project is under the GNU General Public License v3.0