https://github.com/itsron143/xkcd

A minimal command line tool for your daily dose of xkcd comics written in python.
https://github.com/itsron143/xkcd

click command-line-tool fun python-3 terminal xkcd-api xkcd-comics

Last synced: 5 months ago
JSON representation

A minimal command line tool for your daily dose of xkcd comics written in python.

• Host: GitHub
• URL: https://github.com/itsron143/xkcd
• Owner: itsron143
• License: mit
• Created: 2018-08-16T10:01:53.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2022-09-26T03:41:04.000Z (about 3 years ago)
• Last Synced: 2025-05-12T23:43:57.645Z (5 months ago)
• Topics: click, command-line-tool, fun, python-3, terminal, xkcd-api, xkcd-comics
• Language: Python
• Homepage:
• Size: 5.79 MB
• Stars: 66
• Watchers: 3
• Forks: 7
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# XKCD

[![Build Status](https://travis-ci.org/itsron717/XKCD.svg?branch=master)](https://travis-ci.org/itsron717/XKCD)

[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)



xkcd, sometimes styled _XKCD_ is a [webcomic](https://en.wikipedia.org/wiki/Webcomic) created by American author [Randall Munroe](https://en.wikipedia.org/wiki/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](https://xkcd.com/json.html) to get the image and the [Click](http://click.pocoo.org/) 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](https://www.linkedin.com/in/itsron143/)