xkcd-scrape 0.4.0

Scrape the XKCD comic archive

XKCD Scrape

xkcd-scrape is a Python module to dump the XKCD.com archive and get comic info using BS4. Honestly, it's a very basic module with one premise - easily get information about comics.

Examples

Basic usage:

from xkcdscrape import xkcd

# Load the archive of comics into a variable
archive = xkcd.parseArchive()

# Get info about latest comic
info = xkcd.getComicInfo(archive)

# Get info about specific comic
# The comic can either be an int (200), a str ("200"|"/200/"), or a link ("https://xkcd.com/200")
info = xkcd.getComicInfo(archive, 2000)

# Get info about a random comic
# Passing the second paramenter as True makes the module only fetch comics that are present in the archive
info = xkcd.getRandomComic(archive, False)

# You can pass None for archive, in that case there won't be a date in response
# When passing None to getRandomComic - fromArchive will always be True
info = xkcd.getComicInfo(None, 2000)
info = xkcd.getRandomComic(None)

# Dump archive to file
xkcd.dumpToFile(archive, "dump.json")

# Get info using archive dump. You can do the same with getRandomComic()
info = xkcd.getComicInfo("dump.json", 2000)

The getComicInfo function (also called inside of getRandomComic) returns a dict with following keys:

# xkcd.getComicInfo(archive, 2000)
{
    'num': '2000', 
    'link': 'https://xkcd.com/2000/', 
    'name': 'xkcd Phone 2000', 
    'date': '2018-5-30', 
    'image': 'https://imgs.xkcd.com/comics/xkcd_phone_2000.png', 
    'title': 'Our retina display features hundreds of pixels per inch in the central fovea region.'
}

As you can see, it returns the following list of keys:

• num - comic number
• link - hyperlink to comic
• name - the name of the comic
• date - YYYY-MM-DD formatted date of when the comic was posted (not returned if archive is None)
• image - hyperlink to image used in the comic
• title - title (hover) text of the comic

Archive

The XKCD archive is where we get the list of comics, as well as their names and date of posting. This is the only place where we can get the date of posting, so it's required if you need the date.

The archive is a dict containing various dicts with keys of /num/. Example:

{
    ...,
    "/2000/": {
        "date": "2018-5-30", 
        "name": "xkcd Phone 2000"
    },
    ...
}

Tests

Tests can be run from the project's shell after installing and activating the venv using poetry run pytest. Use Python's included unittest module for creating tests (examples are in tests/).

TODO

• Add shields.io badges when 525 errors self-resolve
• Add RSS/Atom feed support to fetch latest comic
• API and homepage (on one domain)