<p align="center">
<img src="https://raw.githubusercontent.com/TabulateJarl8/randfacts/master/imgs/logo-embedded-font.svg" />
</p>
<p align="center">
<a href="https://badge.fury.io/py/randfacts"><img alt="PyPI" src="https://img.shields.io/pypi/v/randfacts" /></a>
<a href="https://aur.archlinux.org/packages/python-randfacts/"><img alt="AUR version" src="https://img.shields.io/aur/version/python-randfacts"></a>
<a href="https://pepy.tech/project/randfacts"><img alt="Downloads" src="https://pepy.tech/badge/randfacts" /></a>
<a href="https://pypi.python.org/pypi/randfacts/"><img alt="PyPI license" src="https://img.shields.io/pypi/l/randfacts.svg" /></a>
<a href="https://GitHub.com/TabulateJarl8/randfacts/graphs/commit-activity"><img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" /></a>
<a href="https://GitHub.com/TabulateJarl8/randfacts/issues/"><img alt="GitHub Issues" src="https://img.shields.io/github/issues/TabulateJarl8/randfacts.svg" /></a>
<a href="https://github.com/TabulateJarl8/randfacts/actions/workflows/main.yml"><img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/TabulateJarl8/randfacts/main.yml?branch=master&label=Duplicate%20Facts%20Test" /></a>
<a href="https://github.com/TabulateJarl8"><img alt="GitHub followers" src="https://img.shields.io/github/followers/TabulateJarl8?style=social" /></a>
<a href="https://github.com/TabulateJarl8/randfacts"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/TabulateJarl8/randfacts?style=social" /></a>
<br>
<a href="https://ko-fi.com/L4L3L7IO2"><img alt="Kofi Badge" src="https://ko-fi.com/img/githubbutton_sm.svg" /></a>
</p>
Randfacts is a Python module that generates random facts. You can use `randfacts.get_fact()` to return a random fun fact. Disclaimer: Facts are not guaranteed to be true.
# Installation
randfacts can either be installed via pip or via the AUR, whichever way you prefer.
### Installation via pip:
```sh
$ pip3 install randfacts
```
### Installation via AUR:
Via your AUR helper, like paru:
```sh
$ paru -S python-randfacts
```
Or manually
```sh
$ git clone https://aur.archlinux.org/python-randfacts.git && cd python-randfacts
$ makepkg -si
```
# Usage and examples
```python
import randfacts
x = randfacts.get_fact()
print(x)
```
The above example will print a random fact like:
`Penguins can't taste sweet or savory flavors, only sour and salty ones`
This package has a filter option to filter out potentially inappropriate facts. The filter is on by default. To disable the filter, you can just set the `filter_enabled` parameter to `False`.
```python
from randfacts import get_fact
print(get_fact(False))
# or
print(get_fact(filter_enabled=False))
```
`get_fact` also has a parameter that will make the function only return unsafe facts. This argument takes precedence over the `filter_enabled` argument. For example:
```py
print(get_fact(only_unsafe=True))
```
If you want to access the list of facts directly, you can just import the `safe_facts`, `unsafe_facts`, or `all_facts` lists from the randfacts module.
## Command line usage
randfacts can be executed via the command line with the following commands:
Normal execution; only SFW (safe for work) facts
```sh
$ python3 -m randfacts
```
The unsafe argument can be supplied to provide only NSFW (not safe for work) facts
```sh
$ python3 -m randfacts --unsafe
```
The mixed argument can be provided to provide both SFW and NSFW facts.
```sh
$ python3 -m randfacts --mixed
```
More help.
```sh
$ python3 -m randfacts --help
```
Raw data
{
"_id": null,
"home_page": "https://github.com/TabulateJarl8/randfacts",
"name": "randfacts",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Tabulate",
"author_email": "tabulatejarl8@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/21/d4/2d3fd9f5e366ec84870798aca8f895af75ef71251abaed482374e9cd2ad9/randfacts-0.21.0.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n<img src=\"https://raw.githubusercontent.com/TabulateJarl8/randfacts/master/imgs/logo-embedded-font.svg\" />\n</p>\n<p align=\"center\">\n\t<a href=\"https://badge.fury.io/py/randfacts\"><img alt=\"PyPI\" src=\"https://img.shields.io/pypi/v/randfacts\" /></a>\n\t<a href=\"https://aur.archlinux.org/packages/python-randfacts/\"><img alt=\"AUR version\" src=\"https://img.shields.io/aur/version/python-randfacts\"></a>\n\t<a href=\"https://pepy.tech/project/randfacts\"><img alt=\"Downloads\" src=\"https://pepy.tech/badge/randfacts\" /></a>\n\t<a href=\"https://pypi.python.org/pypi/randfacts/\"><img alt=\"PyPI license\" src=\"https://img.shields.io/pypi/l/randfacts.svg\" /></a>\n\t<a href=\"https://GitHub.com/TabulateJarl8/randfacts/graphs/commit-activity\"><img alt=\"Maintenance\" src=\"https://img.shields.io/badge/Maintained%3F-yes-green.svg\" /></a>\n\t<a href=\"https://GitHub.com/TabulateJarl8/randfacts/issues/\"><img alt=\"GitHub Issues\" src=\"https://img.shields.io/github/issues/TabulateJarl8/randfacts.svg\" /></a>\n\t<a href=\"https://github.com/TabulateJarl8/randfacts/actions/workflows/main.yml\"><img alt=\"GitHub Workflow Status\" src=\"https://img.shields.io/github/actions/workflow/status/TabulateJarl8/randfacts/main.yml?branch=master&label=Duplicate%20Facts%20Test\" /></a>\n\t<a href=\"https://github.com/TabulateJarl8\"><img alt=\"GitHub followers\" src=\"https://img.shields.io/github/followers/TabulateJarl8?style=social\" /></a>\n\t<a href=\"https://github.com/TabulateJarl8/randfacts\"><img alt=\"GitHub Repo stars\" src=\"https://img.shields.io/github/stars/TabulateJarl8/randfacts?style=social\" /></a>\n\t<br>\n\t<a href=\"https://ko-fi.com/L4L3L7IO2\"><img alt=\"Kofi Badge\" src=\"https://ko-fi.com/img/githubbutton_sm.svg\" /></a>\n</p>\n\nRandfacts is a Python module that generates random facts. You can use `randfacts.get_fact()` to return a random fun fact. Disclaimer: Facts are not guaranteed to be true.\n\n# Installation\n\nrandfacts can either be installed via pip or via the AUR, whichever way you prefer.\n\n### Installation via pip:\n\n```sh\n$ pip3 install randfacts\n```\n\n### Installation via AUR:\n\nVia your AUR helper, like paru:\n```sh\n$ paru -S python-randfacts\n```\n\nOr manually\n```sh\n$ git clone https://aur.archlinux.org/python-randfacts.git && cd python-randfacts\n$ makepkg -si\n```\n\n# Usage and examples\n\n```python\nimport randfacts\nx = randfacts.get_fact()\nprint(x)\n```\nThe above example will print a random fact like:\n`Penguins can't taste sweet or savory flavors, only sour and salty ones`\n\nThis package has a filter option to filter out potentially inappropriate facts. The filter is on by default. To disable the filter, you can just set the `filter_enabled` parameter to `False`.\n```python\nfrom randfacts import get_fact\nprint(get_fact(False))\n# or\nprint(get_fact(filter_enabled=False))\n```\n\n`get_fact` also has a parameter that will make the function only return unsafe facts. This argument takes precedence over the `filter_enabled` argument. For example:\n\n```py\nprint(get_fact(only_unsafe=True))\n```\n\nIf you want to access the list of facts directly, you can just import the `safe_facts`, `unsafe_facts`, or `all_facts` lists from the randfacts module.\n\n\n## Command line usage\n\nrandfacts can be executed via the command line with the following commands:\n\nNormal execution; only SFW (safe for work) facts\n\n```sh\n$ python3 -m randfacts\n```\n\nThe unsafe argument can be supplied to provide only NSFW (not safe for work) facts\n\n```sh\n$ python3 -m randfacts --unsafe\n```\n\nThe mixed argument can be provided to provide both SFW and NSFW facts.\n\n```sh\n$ python3 -m randfacts --mixed\n```\n\nMore help.\n\n```sh\n$ python3 -m randfacts --help\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "Package to generate random facts",
"version": "0.21.0",
"project_urls": {
"Homepage": "https://github.com/TabulateJarl8/randfacts"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3baae790d010d741a0db0316ec49aae86a9ea2c8301af71f5135f4e87dbb5c62",
"md5": "d15b7ee7cccd55e4d3533bb96c7424ed",
"sha256": "1afc1cae2bcf8521c37fbd16b52e52661429c5576ded0661abe0aa602e028d7c"
},
"downloads": -1,
"filename": "randfacts-0.21.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d15b7ee7cccd55e4d3533bb96c7424ed",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 273818,
"upload_time": "2023-11-14T17:16:18",
"upload_time_iso_8601": "2023-11-14T17:16:18.483853Z",
"url": "https://files.pythonhosted.org/packages/3b/aa/e790d010d741a0db0316ec49aae86a9ea2c8301af71f5135f4e87dbb5c62/randfacts-0.21.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "21d42d3fd9f5e366ec84870798aca8f895af75ef71251abaed482374e9cd2ad9",
"md5": "83d75ccfc6c872023ada0db11ff5373f",
"sha256": "6589fe6977fc09c754596f06f1c96537596c39c3b0676608ba6890f1f2a5c3cc"
},
"downloads": -1,
"filename": "randfacts-0.21.0.tar.gz",
"has_sig": false,
"md5_digest": "83d75ccfc6c872023ada0db11ff5373f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 273596,
"upload_time": "2023-11-14T17:16:20",
"upload_time_iso_8601": "2023-11-14T17:16:20.761057Z",
"url": "https://files.pythonhosted.org/packages/21/d4/2d3fd9f5e366ec84870798aca8f895af75ef71251abaed482374e9cd2ad9/randfacts-0.21.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-14 17:16:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "TabulateJarl8",
"github_project": "randfacts",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "randfacts"
}
JSON
