oss2019 / pyquotes

API in python to get quotes.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

pyquotes

Issues Pull Requests License Gitter


This is an API in python3 to get quotes.

Plan

Phase 1

The idea is to use scrap the quotes from various websites (BrainyQuote,quoteload). We will use beautifulsoup4 for this.
To get started with this you can watch a small tutorial here.
Functionalities to be supported are:

  • Get quotes from particular topic, categories. (love, classics, passion)
  • Get quotes from particular person. (George Orwell, Stephen King, J.K Rowling, etc)

Phase 2

Convert this into a pip package. Read more about pip here. Guide on creating a pip package here

Phase 3

Use what we have built till now to make a twitter bot which will tweet quotes everyday. Guide on creating a twitter bot here

Contribution Guidelines

We would love contributions from everyone. Some general guidelines are:

  • Write neat code with proper comments.
  • Follow PEP8 coding style.
  • Write tests wherever necessary.
  • Write descriptive commit messages.
  • It is recommended to have a single commit for a task.
  • Please see that all the tests are passing before asking for a review on a PR.

Dependencies

  • fuzzywuzzy
  • requests
  • beautifulsoup4
  • html5lib

To install all dependencies at once run pip install -r requirements.txt

Mentors

For any more information, join Gitter channel Gitter

Legal

Please refer to the licence

About

API in python to get quotes.

License:MIT License


Languages

Language:Python 100.0%