A wrapper for the xkcd API
Project description
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
'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,
... 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
Ideas for the Future
- retrieve comic .jpeg
History
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
0.1.0 (23-04-2020)
- First release on PyPI
- Client and Comic classes
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
xkcd-wrapper-0.2.2.tar.gz
(7.8 kB
view hashes)
Built Distribution
Close
Hashes for xkcd_wrapper-0.2.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 513c885c055c60e1da20d5c3d150a2b6a24924a8a8f246ffe4a958a66b4d9311 |
|
MD5 | 77ddf4869bf9f976cca3d256dd238f68 |
|
BLAKE2b-256 | e99a2766b42f25d128c912620327949062e961d8fa8021dc85815304f52cf97a |