Skip to content

Latest commit

 

History

History
46 lines (25 loc) · 2.37 KB

README.md

File metadata and controls

46 lines (25 loc) · 2.37 KB

🦴 havhav

Checked with mypy Code style: black codecov

CodeQL Code format checkers Tests Documentation Status Release pre-commit.ci status

PyPI version

FOSSA Status

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

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.']