wrap-away/marvel-api

API wrapper for Marvel

Marvel API

Installation

Using pip:

pip install marvel

This is an API wrapper for Marvel.

Usage

Usage is as simple as it gets:

from marvel import Marvel
m = Marvel(PUBLIC_KEY, PRIVATE_KEY)

Now there are six objects presented namely, characters, comics, creators, events, series and stories as listed at Developers

characters = m.characters
comics = m.comics
creators = m.creators
events = m.events
series = m.series
stories = m.stories

Each of the above object returns back the appropriate response (json) as mentioned in official docs

Module Examples

Module Examples:

m = Marvel(PUBLIC_KEY, PRIVATE_KEY)
characters = m.characters

Get All Characters:

all_characters = characters.all()

Get Single Character:

character = characters.get(1011334)

Get Some Character's Comics:

comics = characters.comics(1011334)

Similarly, you could apply the same logic to different objects, an example:

m = Marvel(PUBLIC_KEY, PRIVATE_KEY)
stories = m.stories
all_stores = stories.all()
story = stories.get(id)
events = stories.events(id)

Finally, the sub resources that each object has are as follows:

• Characters
  • all, get, comics, events, series, stories
• Comics
  • all, get, characters, creators, events, stories
• Creators
  • all, get, comics, events, series, stories
• Events
  • all, get, characters, comics, creators, series, stories
• Series
  • all, get, characters, comics, creators, events, stories
• Stories
  • all, get, characters, comics, creators, events, series

Exception Handling

You can catch any exception caused by Marvel API such as authentication error, bad input error, server down error, etc by handling the MarvelException at marvel/exceptions.py.

Running Tests

python -m pytest tests/

marvel-api's Issues

How to modify offset and limit params

How to modify offset and limit params and get more items at one request?

Get all characters does not include paging and offset

Can't get all characters to return without the paging and offset as you can't get all the characters at once due to API restrictions. It's probably the same with other api calls. It's a neat python module though, just needs a paging and offset capability to gather all the data.

data=characters.all()
pretty_data=json.dumps(data)
pretty_characters=json.loads(pretty_data, object_hook=lambda d: namedtuple('X', d.keys())(*d.values()))
print("Standard Character Limit: ", pretty_characters.data.limit)
print("Total Number of Characters: ", pretty_characters.data.total)
print("Current Offset: ", pretty_characters.data.offset)

Result:
Standard Character Limit: 20
Total Number of Characters: 1493
Current Offset: 0

You could make a loop to increment the offset and add those to a json object incrementing the offset by 20 until all the characters are accounted for.