Skip to content

Latest commit

 

History

History
46 lines (35 loc) · 1.66 KB

README.md

File metadata and controls

46 lines (35 loc) · 1.66 KB

xkcd 303 xkcd logo xkcd 1987

A simple script utilizing Pillow to display an xkcd comic. Can fetch either the latest comic, a random comic, or a specific comic by number. In the terminal window, the script displays the comic number, title, release date, and alt-text. This script is made possible thanks to the xkcd JSON API (https://xkcd.com/json.html).

To install this script, run the following command:

curl -fsSL https://raw.githubusercontent.com/kevinshome/xkcd/main/install.py | python3 -

To install with the full database of comics:

curl -fsSL https://raw.githubusercontent.com/kevinshome/xkcd/main/install.py | python3 - --install-db

Database

In order to search by keyword, the comic database (xkcd-comicdb) is required. It can be installed either by running the installation script with the "--install-db" flag, or directly from PyPI.

Updating

To check for available updates for the script, run:

$ xkcd --update

To check for available updates for the database, run:

$ xkcd --update-db

License

All xkcd comics are released under a Creative Commons Attribution-NonCommercial 2.5 License.

This software is released into the public domain under the terms of the Unlicense, made available in the 'LICENSE' file in the root of this project.