Skip to content

suman-kr/quoters

Repository files navigation

quoters

A pythonic random quote generator with multiple categoties. (Python 3)

codecov.io Pypi Downloads npm version

PyPi

Installation

pip install quoters

Running and usage

from quoters import Quote
print(Quote.print())

Available Functions

print() # Returns random quotes
print_series_quote() # Returns random TV shows quotes
print_anime_quote() # Returns random Anime quotes
print_programming_quote() # Returns random Programming quotes

Offline usage example

print(True)

Note: Pass True as a parameter for fallback. It works for all the available functions.

NPM

Installation

npm install quoters

Running and usage

// ES6 and Typescript
import Quote from 'quoters';
const randomQuote = new Quote('QUOTE').get()
console.log(randomQuote);

// ES5 and old JS
var Quote = require('quoters').default;
const randomQuote = new Quote('QUOTE').get()
console.log(randomQuote);

Categories

- QUOTE: Random quote
- ANIME: Random anime quote
- SERIES: Random famous TV series quote
- PROGRAMMING: Random geeky quote xD

CLI

BASH / ZSH shell configuration (Linux and MacOS)

git clone --branch master https://github.com/suman-kr/quoters.git && cd quoters
chmod +x quoters_script.py
pip install -r requirements.txt
ln -s <ABSOLUTE_PATH_TO_CLONED_REPO>/quoters_script.py /usr/local/bin/quoters

### Add the below line to your .bashrc / .zshrc  
export PATH=$PATH:/usr/local/bin 

Running and usage

quoters help # List down all the available categories

API

The package can also be used from API. API is hosted on Heroku

http://py-quoters.herokuapp.com/ [Random quote]
http://py-quoters.herokuapp.com/?query=series [Random TV Shows quote]
http://py-quoters.herokuapp.com/?query=anime [Random Anime characters quote]
http://py-quoters.herokuapp.com/?query=programming [Random Programming quote]

Resources

The data consumed are from the following sources:

Thanks! ❤️