Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/suman-kr/quoters
:pencil: Random quotes generator package. Available on npm and PyPi
https://github.com/suman-kr/quoters
beautifulsoup4 fastapi hacktoberfest npm python quoters quotes random scraper typescript
Last synced: 11 days ago
JSON representation
:pencil: Random quotes generator package. Available on npm and PyPi
- Host: GitHub
- URL: https://github.com/suman-kr/quoters
- Owner: suman-kr
- License: mit
- Created: 2020-01-23T20:33:24.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-06T19:19:32.000Z (5 months ago)
- Last Synced: 2024-11-15T04:49:40.852Z (about 1 month ago)
- Topics: beautifulsoup4, fastapi, hacktoberfest, npm, python, quoters, quotes, random, scraper, typescript
- Language: Python
- Homepage: https://suman-kr.github.io/quoters/
- Size: 2.89 MB
- Stars: 18
- Watchers: 4
- Forks: 0
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# quoters
A pythonic random quote generator with multiple categoties. (Python 3)
[](https://codecov.io/github/suman-kr/quoters?branch=master) [](https://pepy.tech/project/quoters) [](https://badge.fury.io/js/quoters)
## PyPi
> Installation
```sh
pip install quoters
```
> Running and usage
```py
from quoters import Quote
print(Quote.print())
```
> Available Functions
```py
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
```py
print(True)
```
`Note: Pass True as a parameter for fallback. It works for all the available functions.`
## NPM
> Installation
```sh
npm install quoters
```
> Running and usage
```js
// 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)
```sh
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 /quoters_script.py /usr/local/bin/quoters
### Add the below line to your .bashrc / .zshrc
export PATH=$PATH:/usr/local/bin
```
> Running and usage
```sh
quoters help # List down all the available categories
```
## API
The package can also be used from API. API is hosted on [Heroku](https://www.heroku.com/)
```
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:
- https://www.yourselfquotes.com/thought-of-the-day/
- https://www.tvtime.com/article/top-50-unforgettable-tv-quotes
- https://bayart.org/anime-quotes/
- https://betterprogramming.pub/101-funny-programmer-quotes-76c7f335b92d
### Thanks! :heart: