https://github.com/codecanna/petfacts
https://github.com/codecanna/petfacts
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/codecanna/petfacts
- Owner: CodeCanna
- License: gpl-3.0
- Created: 2021-11-07T13:30:44.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-12-20T04:13:22.000Z (over 1 year ago)
- Last Synced: 2025-05-02T13:07:23.518Z (about 1 year ago)
- Language: Python
- Size: 132 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# About the petfacts CLI application
Pet facts is a simple but fun application that retrieves either dog or cat facts from two different resources.
[Click here](https://catfact.ninja) to see the cat facts api.
[Click here](https://dog-facts-api.herokuapp.com) to see the dog facts api.
## Why did I write it?
I wrote this application to learn a python module called argparse, and this seemed like the perfect fun project to do this with.
## How can I get it?
You can clone the repository on [GitHub](https://github.com/CodeCanna/petfacts) or install via `pip` by running `pip install petfacts`
## How to use
This is a very simple and light program, to see a random pet fact of a dog or cat variety simply run `petfacts` with not arguments.
If you want to specify a whether you want a dog or car fact pass in the arguments like so:
* `petfacts --cat` will return a cat fact.
* `petfacts --dog` will return a dog fact.
* `petfacts --help` or `petfacts -h` of course returns a help menu and exits.
### Whats next?
* TODO: Give it the ability to store facts, why? Just because I'm learning.