metron-project / mokkari

Python wrapper for Metron API

Mokkari

Quick Description

A python wrapper for the metron.cloud API.

Installation

PyPi

$ pip3 install --user mokkari

Example Usage

import mokkari

# Your own config file to keep your credentials secret
from config import username, password

m = mokkari.api(username, password)

# Get all Marvel comics for the week of 2021-06-07
this_week = m.issues_list({"store_date_range_after": "2021-06-07", "store_date_range_before": "2021-06-13", "publisher_name": "marvel"})

# Print the results
for i in this_week:
    print(f"{i.id} {i.issue_name}")

# Retrieve the detail for an individual issue
asm_68 = m.issue(31660)

# Print the issue Description
print(asm_68.desc)

Documentation

• Read the project documentation

Bugs/Requests

Please use the GitHub issue tracker to submit bugs or request features.

License

This project is licensed under the GPLv3 License.

mokkari's Issues

Issue.issue_name not returned

Describe the bug
The Issue schema doesn't have issue_name marked as optional, however Metron doesn't always return this field and it doesn't raise an exception.

To Reproduce

1. Make a call to result = session.issue(_id=39505)
2. Try and access the issue_name field: result.issue_name
3. An AttributeError is raised:

AttributeError: 'Issue' object has no attribute 'issue_name'

Expected behavior
It should either raise an exception or the field be Optional

Desktop (please complete the following information):

• OS: Windows

Additional context

Use correct Version in user-agent string

Currently the user-agent string uses a hard-coded version number:

https://github.com/bpepple/mokkari/blob/1143090b89411ef6654c0378afdbe5de140249f5/mokkari/session.py#L50

Need to update this to use the package version number without creating a circular reference.

https://github.com/bpepple/mokkari/blob/1143090b89411ef6654c0378afdbe5de140249f5/mokkari/__init__.py#L7

[Docs] Wrong parameter listed for mokkari.api()

Describe the bug
The parameters for mokkari.api() are listed incorrectly, for example user_agent being in front of SqliteCache instead of cache.

Add `Universe` Endpoint

Is your feature request related to a problem?
No

Describe the solution you'd like
Add support for new Metron API Universe endpoint.

Add option to have the sqlite cache expire

Is your feature request related to a problem? Please describe.
It would be nice to have an option to have the database cache expire at a certain length of time.

Describe the solution you'd like
Expose an option to set an optional expiration date for the database cache.

series_list returns 'display_name' instead of 'name' for Series objects

Describe the bug
When running a series_list search through mokkari, I'm getting results with a 'display_name' field instead of just 'name'. From what I can see, this includes the series start year in the name.

Expected behavior
It would be much nicer if the name field was returned without including a start year in brackets. The 'year_began' field already contains this information, and it makes name matching much more tedious when I have to first clean up the title before processing.

Extra Information
This seems to be a limitation of the API, not mokkari. When testing on the API page, you can see similar results for every Series object.

Contributor API, allow PUTs that go into editorial queue prior to committing to main DB

Is your feature request related to a problem? Please describe.
Not related to a bug but would allow for creation of automated pulling from contributor's backlog series/issues with metadata from various sources which may in turn increase contributions to the dataset.

Describe the solution you'd like
An API for PUT calls of all metadata related fields including ability to create series and feed new series ID to allow filling of all subsidiary info into the newly created series.

Suggested reference implementation:
Tagged library is parsed by shell/python script for metadata and series name
API call to cross check series' existence, auto-create with series name sent on API call and come back with new/existing series ID as applicable
Update each issue with 1 set of any metadata existing in the comic archives - so 1 API call for all metadata items of each issue
(optional but should be heavily encouraged) 1 more API call per issue to send the 1st page of the archive/Cover. This should have a 90% success rate or more with the people who are likely to share their metadata being usually serious collectors.
Move to next series once complete.

I do recommend each contributed series to go into the editorial queue, similar as they may for bulk website changes.

Describe alternatives you've considered
Anything but entering in (in my case) 41k issues by hand and uploading covers by hand.

Additional context
Many apologies if this is the wrong github issues page, I did look for the main project's page but this is the closest project to relevant I could find.

Allow additional custom text to user-agent

Currently the user-agent appears fixed? For traffic analysis, I think allowing a custom limited length additional string would be of benefit.