xkcd-wrapper

A Python wrapper for the xkcd webcomic API.

Retrieves xkcd comic data and metadata as python objects.

Asynchronous (async) and synchronous implementations.

Installation

At the command line, with pip,

synchronous implementation:

$ pip install xkcd-wrapper[sync]

async implementation:

$ pip install xkcd-wrapper[async]

Usage

synchronous:

>>> import xkcd_wrapper

>>> client = xkcd_wrapper.Client()
>>> specific_comic = client.get(100)        # Comic object with comic 100 data
>>> latest_comic = client.get_latest()      # Comic object containing data of the latest xkcd comic
>>> random_comic = client.get_random()      # Comic object of a random comic

>>> specific_comic
xkcd_wrapper.Comic(100)
>>> specific_comic.image_url
'https://imgs.xkcd.com/comics/family_circus.jpg'

async:

>>> import xkcd_wrapper, asyncio
>>> async_client = xkcd_wrapper.AsyncClient()

>>> async def async_call():
...     responses = await asyncio.gather(
...         async_client.get(100),          # Comic object with comic 100 data
...         async_client.get_latest(),      # Comic object containing data of the latest xkcd comic
...         async_client.get_random()       # Comic object of a random comic
...     )
...     print(
...         responses[0],                   # async_client.get(100) output
...         responses[0].image_url,
...         sep='\n'
...     )

>>> asyncio.run(async_call())
xkcd_wrapper.Comic(100)
'https://imgs.xkcd.com/comics/family_circus.jpg'

Documentation

Check the documentation for more details: https://xkcd-wrapper.readthedocs.io/en/latest

History

1.0.2 (01-11-2022)

• Support Python 3.10
• Update dependencies

1.0.1 (28-02-2021)

• Deprecate Python 3.5
• Support Python 3.9
• Update dependencies

1.0.0 (06-09-2020)

• Reworked xkcd API response json decoding
• Reworked Comic
• Client and AsyncClient can now retrieve comic images

0.2.2 (13-08-2020)

• Fixed failing to import xkcd_wrapper if either only requests or aiohttp were installed

0.2.1 (11-08-2020)

• Separate dependencies (you can now use the async implementation without having to install the sync dependencies and vice versa)

0.2.0 (08-08-2020)

• Async implementation (AsyncClient)

0.1.0 (23-04-2020)

• First release on PyPI
• Client and Comic classes