Metadata-Version: 2.1
Name: mokkari
Version: 2.3.3
Summary: Python wrapper for Metron API
License: GPL-3.0-or-later
Keywords: comics,comic,metadata
Author: Brian Pepple
Author-email: bdpepple@gmail.com
Maintainer: Brian Pepple
Maintainer-email: bdpepple@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: BSD
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Internet
Provides-Extra: docs
Requires-Dist: marshmallow (>=3.13.0,<4.0.0)
Requires-Dist: ratelimit (>=2.2.1,<3.0.0)
Requires-Dist: requests (>=2.26.0,<3.0.0)
Requires-Dist: sphinx-rtd-theme (>=0.5.2,<0.6.0); extra == "docs"
Requires-Dist: sphinxcontrib-napoleon (>=0.7,<0.8); extra == "docs"
Project-URL: Bug Tracker, https://github.com/Metron-Project/mokkari/issues
Project-URL: Homepage, https://github.com/Metron-Project/mokkari
Description-Content-Type: text/x-rst

=======
Mokkari
=======
.. image:: https://img.shields.io/pypi/v/mokkari.svg?logo=PyPI&label=Version&style=flat-square   :alt: PyPI
    :target: https://pypi.org/project/mokkari

.. image:: https://img.shields.io/pypi/pyversions/mokkari.svg?logo=Python&label=Python-Versions&style=flat-square
    :target: https://pypi.org/project/mokkari

.. image:: https://img.shields.io/github/license/bpepple/mokkari
    :target: https://opensource.org/licenses/GPL-3.0

.. image:: https://codecov.io/gh/Metron-Project/mokkari/branch/main/graph/badge.svg?token=QU1ROMMOS4 
    :target: https://codecov.io/gh/Metron-Project/mokkari

.. image:: https://img.shields.io/badge/Code%20Style-Black-000000.svg?style=flat-square
    :target: https://github.com/psf/black

Quick Description
-----------------
A python wrapper for the metron.cloud_ API.

.. _metron.cloud: https://metron.cloud

Installation
------------

PyPi
~~~~

.. code:: bash

  $ pip3 install --user mokkari

Example Usage
-------------
.. code-block:: python

    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 <https://mokkari.readthedocs.io/en/latest/>`_

Bugs/Requests
-------------
  
Please use the `GitHub issue tracker <https://github.com/Metron-Project/mokkari/issues>`_ to submit bugs or request features.

License
-------

This project is licensed under the `GPLv3 License <LICENSE>`_.

