Project Status

Dear users and visitors, this project development is COMPLETED and no further development, from the creator's part, is expected in the foreseen future, but feel free to fork the project and build upon it, or improve it in any way. The latest stable release by the creator is v1.0.2, thanks for your support, keep learning and contributing !

Fun APIs CLI

A simple Python command-line interface utility to interact with various fun APIs: facts, animals, quotes... This project, designed for learning and fun, can pull random facts, animal data, quotes and much more via API Ninjas and other API sources.

Installation

There are two methods to achive this:

1. Through PyPi: Head to the PyPi project page and install the package, following the instructions.
2. Locally: Clone the repository:

git clone https://github.com/tahadnan/Fun-APIs-CLI.git
cd Fun-APIs-CLI

(Highly Recommended)Set up a virtual environment and install dependencies:

python -m venv venv
source venv/bin/activate  # For Mac/Linux
.\venv\Scripts\activate   # For Windows
pip install -r requirements.txt

Run the program:

python -m fun_apis.main -h 

3. Using UV(May vary from an OS to another):

git clone https://github.com/tahadnan/Fun-APIs-CLI.git
cd Fun-APIs-CLI
uv sync
uv run -m fun_apis.main

Contributing

This project relies on collaboration and community support! It's designed to be an evolving, living tool, and while it currently supports APIs for fun facts, animals, and quotes, the possibilities are endless. Whether you'd like to add new APIs, enhance existing features, refine the code, or even update the documentation, contributions are welcome. Let's make this CLI a better and more diverse tool together. You can fork the repository, look at the code, and send your pull requests-we are excited to see what you will add to the project!