Skip to main content

API service, library and parser for BBFC

Project description

BBFC API

Web API and Python library for BBFC.

High-Level REST Web API

To use the REST API to query BBFC, first run the web server:

$ uvicorn bbfcapi.apiweb:app

Then, to query the API using curl:

$ curl "127.0.0.1:8000?title=interstellar&year=2014"
{"title":"INTERSTELLAR","year":2014,"age_rating":"12"}

Or, to query the API from another web page:

async function call()
{
    const response = await fetch('http://127.0.0.1:8000/?title=interstellar&year=2014');
    const responseJson = await response.json();
    console.log(JSON.stringify(responseJson));
}
call();

Additional notes:

High-Level Python Library

To use the library to get results from BBFC asynchronously:

from bbfcapi.apilib import top_search_result
print(await top_search_result(title="interstellar", year=2014))

To use the library to get results from BBFC synchronously:

import asyncio
from bbfcapi.apilib import top_search_result
print(asyncio.run(top_search_result(title="interstellar", year=2014)))

Low-Level Python Library

To use the library to get raw HTML pages from BBFC asynchronously:

from bbfcapi import client
print(await client.search(title="interstellar", year=2014))

To use the library to get raw HTML pages from BBFC synchronously:

import asyncio
from bbfcapi import client
print(asyncio.run(client.search(title="interstellar", year=2014)))

To use the library to parse raw HTML pages from BBFC:

from bbfcapi import parser
print(parser.parse_top_search_result(b"<BBFC search page byte-string>"))

Development

  1. poetry install to set up the virtualenv (one-off)
  2. poetry run uvicorn bbfcapi.apiweb:app --reload to run the web server
  3. make fix, make check, and make test before committing

There is also make test-live which will run live integration tests against the BBFC website.

Contributing

Pull requests are welcome :)

Publishing

This application is published on PyPi.

  1. Ensure you have configured the PyPi repository with Poetry (one-off)
  2. Run make release to execute the check-list

To publish to the test repository:

  1. Ensure you have configured the Test PyPi repository with Poetry (one-off)
  2. poetry publish --build -r testpypi to upload to the test repository

Changelog

Unreleased

...

v1.0.1 - 2020-01-19

  • Fix parsing 12A age ratings

v1.0.0 - 2020-01-19

  • First release of bbfcapi

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for bbfcapi, version 1.0.1
Filename, size File type Python version Upload date Hashes
Filename, size bbfcapi-1.0.1-py3-none-any.whl (16.5 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size bbfcapi-1.0.1.tar.gz (15.9 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page