Foxtrot API

An API for searching and delivering Code Lyoko transcripts and subtitles.

Usage

Check out our

Apiary Documentation

Install (from PyPi)

$ pip install foxtrot-api

Development and Contribution

Install Live Development Version

$ pip install -e .[dev]

Run the API Locally (via Green Unicorn with live-reload)

$ gunicorn --workers 2 --bind :8080 --reload foxtrot_api.__main__:app

Create and Update Manifest

$ rm -f MANIFEST.in && check-manifest --update

Create and Update Sphinx Documentation

$ sphinx-apidoc -f -o docs foxtrot_api && make -C docs html

Deployment

As you would expect, everything in this section requires valid API tokens and misc authentication procedures. This is more of a note for the devs, really.

Build and Deploy to PyPi

$ python setup.py bdist_wheel sdist && twine upload dist/*

Deploy to Google App Engine

$ gcloud app deploy