Skip to content

Latest commit

 

History

History
51 lines (31 loc) · 1.55 KB

README.md

File metadata and controls

51 lines (31 loc) · 1.55 KB
Raw

XKCD

Build Status MIT license

xkcd, sometimes styled XKCD is a webcomic created by American author Randall Munroe. It is a comic of Romance, Sarcasm, Math and Language.

About

xkcd is a command line tool written in Python which will fetch you the comics right in the terminal. This tool uses the xkcd API to get the image and the Click python package to wrap the script into a beautiful command line interface tool.

Supports only Python 3.x and Linux, MacOs and Windows :)

Installation

  • Run the following command

    $ pip install git+https://github.com/itsron717/XKCD

  • Now the package is successfully installed. Run it using the command

    $ xkcd

  • Instruction on how to use the package and it's arguments can be found using --help

    $ xkcd --help

    Feel free to contribute! Let me know if there are any issues with the installation or running of the package using the GitHub issues. All suggestion are welcome.

License

The MIT License (MIT)

Copyright (c) 2018 Rounak Vyas