https://github.com/cobaltgit/adviceslip
A simple client for Tom Kiss' Advice Slip API that doubles as a command line application
https://github.com/cobaltgit/adviceslip
advice adviceslip-api api cli python requests typer
Last synced: 7 months ago
JSON representation
A simple client for Tom Kiss' Advice Slip API that doubles as a command line application
- Host: GitHub
- URL: https://github.com/cobaltgit/adviceslip
- Owner: cobaltgit
- Created: 2022-05-15T12:37:43.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-06-08T13:15:51.000Z (over 3 years ago)
- Last Synced: 2025-01-26T10:30:59.472Z (8 months ago)
- Topics: advice, adviceslip-api, api, cli, python, requests, typer
- Language: Python
- Homepage:
- Size: 282 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# A simple client for Tom Kiss' Advice Slip API that doubles as a command line application
## Installation
```bash
# PyPi install
$ python3.8 -m pip install adviceslip # Python 3.8 or higher is required
# Git install
$ python3.8 -m pip install git+https://github.com/cobaltgit/adviceslip
```
## Example usage
### In a Python program
```py
import adviceslip
with adviceslip.Client() as client: # automatically close client using context manager
random_slip = client.random() # get a random slip
slip_id = 12
slip_from_id = client.slip_from_id(slip_id) # get a slip from an ID
search = client.search("good") # returns a search object, which contains an iterator of slip objects
print(random_slip.id) # print the ID of the random slip
print(slip_from_id.advice) # print the advice from a slip
print(f"Total results from search: {search.total_results}") # print the amount of results from a search object
for slip in search: # iterate over the search object
print(f"#{slip.id}: {slip.date} - {slip.advice}") # print the ID, date and advice of each slip
```
### Command Line
To utilise the command line application, you'll need to install the cli extra
```bash
$ pip install adviceslip[cli]
```
```bash
$ adviceslip id 12 # Get a slip from a specific ID
Always block trolls.
$ adviceslip random # Get a random slip
Eliminate the unnecessary.
$ adviceslip search good # Search for slips using a given query
You can have too much of a good thing.
Good advice is something a man gives when he is too old to set a bad example.
A nod is as good as a wink to a blind horse.
You spend half your life asleep or in bed. It's worth spending money on a good mattress, decent pillows and a comfy duvet.
Be a good lover.
Good things come to those who wait.
Never regret. If it's good, it's wonderful. If it's bad, it's experience.
Never regret. If it's good, it's wonderful. If it's bad, it's experience.
Once you find a really good friend don't do anything that could mess up your friendship.
```
## Development
Feel free to contribute to the library! Here's some simple instructions to get you set up and ready!
* First, you'll need to fork the repository and clone it to a directory on your computer with Git.
```bash
$ git clone https://github.com/username/adviceslip.git # replace username with your GitHub username
```
* Next, install the development dependencies for testing and development purposes. Use the following commands
```bash
$ poetry install
$ poetry run pre-commit install # installs the pre-commit hook for code formatting and linting
```
#### Testing
Before you PR any changes, please test your code
Testing can be done across all compatible Python versions with a simple Tox command that runs `pytest` on your code!
```bash
$ poetry run tox
```