lord-of-the-rings-sdk 0.0.5

Lord of the rings sdk in Python

Lord of the rings sdk

SDK for Lord of the rings api

Setup

Install

  pip install lord-of-the-rings-sdk

API Reference

Imports

  from lord_of_the_rings_sdk import LordOfTheRings

  # The first argument is the token
  api = LordOfTheRings('your token')

Get items eg. books

  # Returns requests.models.Response object
  resp = api.book()

  # Returns json object
  resp.json()

  # Status code
  resp.status_code

Same thing book, movie, character, quote, chapter

Get single item eg. movie

  # if the_id is specified it returns item with specified id
  resp = api.movie(the_id="id of the item")

  # Returns json object
  resp.json()

Same thing book, movie, character, quote, chapter

Get single item attribute eg. single book chapter

  # sends request to /book/{id}/chapter
  resp = api.movie(the_id="id of the item", extra_path="chapter")

  # Returns json object
  resp.json()

Same thing book, movie, character, quote, chapter

Limit, Page, Offset

  # limit by 20, offset by 1 and page 1 (by default a page is limited to 10)
  resp = api.book(limit=20)
  resp = api.book(page=1)
  resp = api.book(offset=1)

  # Returns json object
  resp.json()

Sort

  # syntax 'value to be sorted by:asc or desc' for ascending and descending order respectively
  resp = api.character(sort='name:asc')

  # Returns json object
  resp.json()

Filter

Option	Example	Example
match, negate match	match, negate match	name!=Frodo
include, exclude	race=Hobbit,Human	race!=Orc,Goblino
exists, doesn't exists	name	!name
regex	name=/foot/i	name!=/foot/i
less than, greater than or equal to	budgetInMillions<100	academyAwardWins>0

  # syntax value to be filtered. operation, value
  resp = api.character(filter='race=Hobbit,Human')

  # Returns json object
  resp.json()

Tests

Clone the repo Github

run 'test/name of test'