REST API for guessit
Python
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docker
guessitrest
.dockerignore
.gitignore
.gitmodules
.travis.yml
Dockerfile
HISTORY.rst
LICENSE
MANIFEST.in
README.rst
apidoc.json
dev-requirements.txt
pylintrc
pytest.ini
requirements.txt
setup.cfg
setup.py
swagger.yaml
tox.ini

README.rst

REST WebService for GuessIt

Latest Version LGPLv3 License Build Status Coveralls

GuessIt is a python library that extracts as much information as possible from a video filename.

This is the REST WebService for GuessIt.

Install with pip

Python package is available on PyPI.

$ pip install guessit-rest

Then run guessit rest API using entry point.

$ guessit-rest

Install from sources

$ git clone https://github.com/guessit-io/guessit-rest
$ cd guessit-rest

Then configure a virtualenv with pyenv or any virtualenv manager you may like.

$ pyenv virtualenv ...

Then install dependencies in the virtualenv.

$ pip install -e .

Then run guessit rest API using main module.

$ python guessitrest

Run with Docker

An automated build is available at Docker Hub.

$ docker run -p 5000:5000 -it guessit/guessit-rest

Usage

Connect your browser to http://localhost:5000/?filename=test.avi

API Documentation is available on Swagger UI

A test server is available on https://api.guessit.io. This server has a small API rate limit, so if you really need a GuessIt REST API, you have to host it on your own server.

usage: guessitrest [-h] [-l LISTENING_ADRESS] [-p LISTENING_PORT]

optional arguments:
  -h, --help            show this help message and exit
  -l LISTENING_ADRESS, --listening-adress LISTENING_ADRESS
                        Listening IP Adress of the HTTP Server.
  -p LISTENING_PORT, --listening-port LISTENING_PORT
                        Listening TCP Port of the HTTP Server.

flask-restful

This project currently use a fork of flask-restful. See flask-restful/flask-restful#645.

As a workaround, we use a copy of the forked flask-restul module to make it available from sources.

You can still run REST API with original flask-restful, but using POST with multiple filenames on `/list/` resource is broken.

License

GuessIt is licensed under the LGPLv3 license.