Metadata-Version: 2.4
Name: compuglobal
Version: 0.4.0
Summary: Python wrapper for the CGHMC API (Frinkiac, Morbotron Master Of All Science and more.
Keywords: The Simpsons,Futurama,Rick and Morty,West Wing,Frinkiac,Morbotron,Master of all Science,Capital Beat,API,API Wrapper,CompuGlobal,CompuGlobalHyperMegaNet,CGHMC
Author: MitchellAW
Requires-Python: >=3.13
Description-Content-Type: text/x-rst
License-Expression: MIT
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
License-File: LICENSE
Requires-Dist: aiohttp>=3.14.0
Requires-Dist: pydantic>=2.13.0
Project-URL: Documentation, https://compuglobal.readthedocs.io/en/latest/
Project-URL: Source, https://github.com/MitchellAW/CompuGlobal

.. image:: https://raw.githubusercontent.com/MitchellAW/MitchellAW.github.io/refs/heads/master/images/internet-king.png
        :alt: Internet King Popup Banner by BLUEamnesiac

CompuGlobal
===========

.. image:: https://img.shields.io/pypi/v/compuglobal.svg
   :target: https://pypi.python.org/pypi/compuglobal

.. image:: https://img.shields.io/pypi/pyversions/compuglobal.svg
   :target: https://pypi.python.org/pypi/compuglobal

.. image:: https://app.readthedocs.org/projects/compuglobal/badge/?version=latest&style=flat
   :target: https://compuglobal.readthedocs.io/en/latest/

.. image:: https://img.shields.io/github/actions/workflow/status/MitchellAW/CompuGlobal/test.yml?label=tests
   :target: https://github.com/MitchellAW/CompuGlobal/actions/workflows/test.yml

.. image:: https://img.shields.io/github/license/mitchellaw/compuglobal
   :target: https://github.com/MitchellAW/CompuGlobal/blob/main/LICENSE

Python wrapper for all endpoints of the following undocumented APIs:

`Frinkiac`_, `Morbotron`_, `Master Of All Science`_, and `Capital Beat Us`_.

**Note**: I'll be keeping the wrapper up to date as more APIs are released.


CompuGlobal allows for both random and searchable screencaps, images and gifs
embedded with default or custom captions for the following shows:

*The Simpsons, Futurama, Rick and Morty, and West Wing.*

Make sure to acquaint yourself with the API using the `documentation`_.

Installation
------------
To install the library, you can just run the following command:

::

    python3 -m pip install -U compuglobal


Basic Usage
------------

.. code-block:: py

    import asyncio

    import compuglobal


    async def main():
        simpsons = compuglobal.aio.Frinkiac()

        # Random
        screencap = await simpsons.get_random_screencap()

        # Search
        screencap = await simpsons.search_for_screencap('nothing at all')

        # Images/Gifs
        image = await simpsons.get_comic_panel_url(screencap)
        gif = await simpsons.get_gif_url(screencap)

    if __name__ == '__main__':
        asyncio.run(main())

For documented examples, check `here.`_

Preview
------------
.. image:: https://raw.githubusercontent.com/MitchellAW/MitchellAW.github.io/refs/heads/master/images/nothing-at-all.gif

Credits
------------

Creators and contributors of `Frinkiac`_, `Morbotron`_, `Master of All Science`_, and `Capital Beat Us`_:

- `Paul Kehrer`_
- `Sean Schulte`_
- `Allie Young`_
- `Max`_, `Jon Bernhardt`_, `Nick Beatty`_, `Vimp`_, `juz`_, Iconfactory and `Ged Maheux`_

`BLUEamnesiac`_ for the Internet King Popup Banner

*Named CompuGlobal as shorthand for* `CompuGlobalHyperMegaCap`_, *as the family of websites are named.*

.. _documentation: http://compuglobal.readthedocs.io/
.. _Frinkiac: https://frinkiac.com/
.. _Morbotron: https://morbotron.com/
.. _Master Of All Science: https://masterofallscience.com/
.. _Capital Beat Us: https://capitalbeat.us/
.. _here.: https://github.com/MitchellAW/CompuGlobal/tree/master/examples
.. _Paul Kehrer: https://twitter.com/reaperhulk
.. _Sean Schulte: https://twitter.com/sirsean
.. _Allie Young: https://twitter.com/seriousallie
.. _Max: http://codepen.io/MyXoToD/
.. _Jon Bernhardt: http://www.dafont.com/akbar.font
.. _Nick Beatty: https://twitter.com/bumlaser
.. _Ged Maheux: https://twitter.com/gedeon
.. _Vimp: http://kornykattos.deviantart.com/
.. _juz: http://screenpeepers.com/profile/juz
.. _BLUEamnesiac: https://blueamnesiac.deviantart.com/
.. _CompuGlobalHyperMegaCap: https://langui.sh/2017/07/30/master-of-all-science-rick-and-morty/

