An open API service indexing awesome lists of open source software.

https://github.com/tugrulcan/havhav

:bone: Python package to retrieve random facts about Dogs
https://github.com/tugrulcan/havhav

dogs-over-cats python-library python3-library

Last synced: 3 months ago
JSON representation

:bone: Python package to retrieve random facts about Dogs

Awesome Lists containing this project

README

          

# :bone: havhav

[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
Code style: black
[![codecov](https://codecov.io/gh/tugrulcan/havhav/branch/main/graph/badge.svg?token=upaHgOeki5)](https://codecov.io/gh/tugrulcan/havhav)

[![CodeQL](https://github.com/tugrulcan/havhav/actions/workflows/codeql-analysis.yml/badge.svg?branch=main)](https://github.com/tugrulcan/havhav/actions/workflows/codeql-analysis.yml)
[![Code format checkers](https://github.com/tugrulcan/havhav/actions/workflows/code-quality.yaml/badge.svg)](https://github.com/tugrulcan/havhav/actions/workflows/code-quality.yaml)
[![Tests](https://github.com/tugrulcan/havhav/actions/workflows/test.yaml/badge.svg)](https://github.com/tugrulcan/havhav/actions/workflows/test.yaml)
[![Documentation Status](https://readthedocs.org/projects/havhav/badge/?version=latest)](https://havhav.readthedocs.io/en/latest/?badge=latest)
[![Release](https://github.com/tugrulcan/havhav/actions/workflows/release.yaml/badge.svg)](https://github.com/tugrulcan/havhav/actions/workflows/release.yaml)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/tugrulcan/havhav/main.svg)](https://results.pre-commit.ci/latest/github/tugrulcan/havhav/main)

[![PyPI version](https://badge.fury.io/py/havhav.svg)](https://badge.fury.io/py/havhav)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Ftugrulcan%2Fhavhav.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Ftugrulcan%2Fhavhav?ref=badge_large)

## Installation

### Install using pip

Instructions for installing, for example command of package manager like

pip install havhav

Add reference on used package manager or other details so users unfamiliar with this programming language understand the context.

Note the `pip` refers to the Python 3 package manager. In environment where Python 2 is also available the correct command may be `pip3`.

If the installation instructions are very complex or only relevant to specific environments or use cases, consider creating a separate documentation and linking it here.

## Usage
```python
from havhav import get_dog_facts

print(get_dog_facts(number_of_facts=1))
>> ['Cerberus was the tri-headed dog that guarded the underworld in Greek mythology.']
```