Welcome to Quote Scraping Tool (QST), an open-source project designed to introduce enthusiasts to the world of open source participation. This project focuses on extracting and providing random quotes from popular quotation website. Whether you're an experienced developer or a novice seeking to make your first contribution, this project provides an appealing and welcoming atmosphere to begin your adventure.
At its core, this project allows you to:
- Fetch a Random Quote
- Fetch Quotes by Tags
Built using Python 3.11, this project is designed to be simple yet extensible.
The project roadmap is loaded with potential. We're looking forward to the following features:
- Additional Quote Providers: We're expanding our sources outside Goodreads.
- Quote Sharing: Implement the ability to share quotes with others.
- Improving documentation: Improving current documentation by fixing language, spelling, and punctuation, as well as improving text clarity and readability.
- Documentation translating: Translating documentation into multiple languages can make a project more accessible, extending its reach and usability.
- Web API Integration: Implement RESTfull routes to expose quotes over a web API.
We are also open to new suggestions! We'd love to hear your ideas for improving GoodQuotes.
Before you begin, ensure you havePython 3.11+ installed on your machine. You may need to install a Python environment manager tool to separate project requirements. I personally prefer mini conda, but you can install venv, virtualenv, pipenv, or any other option that meets your needs.
Clone the repository:
git clone https://github.com/blablageeks/quotes-scraping-tool.git
cd quotes-scraping-toolCreate and enable the project environment for packages isolation
conda create --name quotes-scraping-tool python=3.11
conda activate quotes-scraping-toolInstall the required dependencies:
pip install -r requirements.txtTo fetch a random quote:
python main.pyTo fetch a random quote from a specific tag:
python main.py --tag [tag-name]Available tags (for GoodReads Provider only) are religion, love, inspiration, god, and success
Run python main.pycommand in your terminal to get a random quote from GoodReads Quote site
Run python main.py --tag love command in your terminal to get a random love quote from GoodReads site
Contributing to GoodQuotes is straightforward:
- Fork the Repository: Start by forking the repository to your GitHub account.
- Create an Issue: If you have an idea or find a bug, open an issue to discuss it.
- Work on a Feature or Bug: Choose an existing issue and start working on it.
- Submit a Pull Request: Once you're done, submit a pull request for review.
Check out CONTRIBUTING.md for detailed guidelines on contributing.
- Good Reads
- Brain Quotes
- Az Quotes
- Quotation Page
- The Quote Garden
- Quote Fancy
- Wisdom Quotes
- Insight of the day
- Though Quotations
- Wiki Quotes
This project is released under the MIT License.