Skip to main content

Library to access xkcd.com

Project description

A Python interface to xkcd.com

By Ben Rosser, released under MIT License (see LICENSE for full text).

This is a Python library for accessing and retrieving links to comics from the xkcd webcomic by Randall Munroe. It is NOT endorsed or made by him, it’s an entirely independent project.

It makes use of the JSON interface to Randall’s site to retrieve comic data. Both Python 2 and Python 3 are supported, and there are no dependencies beyond the Python standard library, so xkcd’s footprint should be very light.

There is support for accessing specific comics, the latest comic, or a random comic. Comic metadata can be queried and the comics themselves can be downloaded onto your local system. The goal is simply to provide a relatively Pythonic wrapper around the xkcd API for any Python program or library that wants to access information about xkcd comics, for one reason or another.

The xkcd module, as of version 2.4.0, also supports getting information on What If articles from whatif.xkcd.com. This information is generated by scraping the What If archive page with a HTML parser.

Full API documentation is available here.

Changelog:

Version 2.4.2:

  • Switched to using HTTPS URLs for all xkcd queries.

Version 2.4.1:

  • Routines that take comic/article numbers (e.g. xkcd.getComic()) now also can take strings containing cardinal numbers.

Version 2.4.0:

  • Added preliminary What If support; routines for querying basic data about What If articles now exist.
  • Comic.download() will create its default directory (~/Downloads) if it does not already exist, rather than simply failing.
  • All prints to standard output are now wrapped in “silent” options that now default to True (this affects xkcd.getComic and Comic.download); if silent is set, output won’t be printed.
  • Significantly improved documentation for all available functions and classes.

Version 2.3.3:

  • Made pypandoc conversion optional; long_description will be MD formatted if it cannot be imported (and rST-formatted if it can).

Version 2.3.2:

  • Fixed distutils URL to point at TC01/python-xkcd, not TC01/xkcd.
  • Started using pypandoc to dynamically turn README.md into a RST long-description.

Version 2.3:

  • Fixed ASCII bug in Python 2.x
  • Created Sphinx documentation and uploaded it to pythonhosted.org

Version 2.2:

  • Fixed very silly bug with xkcd.getComic()
  • Added a getExplanation() which returns an explainxkcd link for a Comic().
  • Added support for Python 3!

Version 2.1:

  • Fixed bugs with Comic.download() function
  • Added optional parameter to Comic.download() to change name of output file
  • Added more information to long_description text

Credits:

Contributions from (github users, unless indicated otherwise):

  • @Kyu
  • Tanya Sandoval (@tsando)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
xkcd-2.4.2.tar.gz (10.1 kB) Copy SHA256 hash SHA256 Source None Mar 26, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page