randfacts 0.21.0__py3-none-any.whl → 0.22.0__py3-none-any.whl

randfacts/__init__.py

@@ -5,49 +5,66 @@ You can retrieve facts via the get_fact method. randfacts also allows for
 execution via the command line. See the examples section for more details.
 
 Code Examples:
-		Example usage of randfacts in code.
+				Example usage of randfacts in code.
 
-		Generate a random SFW (safe for work) fact.
+				Generate a random SFW (safe for work) fact.
 
-			>>> randfacts.get_fact()
+						>>> randfacts.get_fact()
 
-		Generate a random NSFW (not safe for work) fact.
+				Generate a random NSFW (not safe for work) fact.
 
-			>>> randfacts.get_fact(only_unsafe=True)
+						>>> randfacts.get_fact(only_unsafe=True)
 
-		Generate a random mixed fact (possibility of both SFW and NSFW facts)
+				Generate a random mixed fact (possibility of both SFW and NSFW facts)
 
-			>>> randfacts.get_fact(False)
-			>>> # or
-			>>> randfacts.get_fact(filter_enabled=False)
+						>>> randfacts.get_fact(filter_enabled=False)
 
 CLI Examples:
-	randfacts can be executed via the command line with the following commands:
+		randfacts can be executed via the command line with the following commands:
 
-	Normal execution; only safe facts
+		Normal execution; only safe facts
 
-		$ python3 -m randfacts
+				$ python3 -m randfacts
 
-	The unsafe argument can be supplied to provide only unsafe facts
+		The unsafe argument can be supplied to provide only unsafe facts
 
-		$ python3 -m randfacts --unsafe
+				$ python3 -m randfacts --unsafe
 
-	The mixed argument can be provided to provide both SFW and NSFW facts.
+		The mixed argument can be provided to provide both SFW and NSFW facts.
 
-		$ python3 -m randfacts --mixed
+				$ python3 -m randfacts --mixed
 
-	More help.
+		More help.
 
-		$ python3 -m randfacts --help
+				$ python3 -m randfacts --help
 
 """
 
-from .__version__ import __title__, __description__, __url__, __version__, __author__, __author_email__, __license__, __copyright__
-from randfacts.randfacts import get_fact, safe_facts, unsafe_facts, all_facts
-
 import warnings as _warnings
+
+from randfacts.randfacts import (
+	__version__,
+	all_facts,
+	get_fact,
+	safe_facts,
+	unsafe_facts,
+)
+
+__all__ = [
+	"__version__",
+	"all_facts",
+	"get_fact",
+	"safe_facts",
+	"unsafe_facts",
+]
+
+
 # Deprecated methods
-def getFact(filter_enabled=True, only_unsafe=False):
-	"""This method is deprecated. Please use get_fact"""
-	_warnings.warn("getFact is deprecated. Please use get_fact", DeprecationWarning, stacklevel=2)
-	return get_fact(filter_enabled, only_unsafe)
+def getFact(filter_enabled: bool = True, only_unsafe: bool = False) -> str:  # noqa: N802
+	"""This method is deprecated. Please use get_fact."""
+	_warnings.warn(
+		"getFact is deprecated. Please use get_fact",
+		DeprecationWarning,
+		stacklevel=2,
+	)
+	return get_fact(filter_enabled, only_unsafe)  # noqa: DOC201

randfacts/__main__.py

@@ -1,2 +1,3 @@
-from .randfacts import _cli_entrypoint
-_cli_entrypoint()
+from .randfacts import _cli_entrypoint  # pyright: ignore[reportPrivateUsage]
+
+_cli_entrypoint()

randfacts/randfacts.py

@@ -1,22 +1,22 @@
-from random import choice
-import os
+"""Contains the core functionality of randfacts."""
+
 import argparse
+import contextlib
+import importlib.metadata
+from pathlib import Path
+from random import choice
+
+dir_path = Path(__file__).resolve().parent
 
-dir_path = os.path.dirname(os.path.realpath(__file__))
+__version__ = ""
+with contextlib.suppress(Exception):
+	__version__: str = importlib.metadata.version("randfacts")
 
-with open(os.path.join(dir_path, 'safe.txt'), encoding='utf-8') as f:
-	safe_facts = [
-		fact.rstrip('\r\n ')
-		for fact in f.readlines()
-		if fact.rstrip('\r\n ') != ''
-	]
+with (dir_path / "safe.txt").open(encoding="utf-8") as f:
+	safe_facts = [fact.rstrip("\r\n ") for fact in f if fact.rstrip("\r\n ")]
 
-with open(os.path.join(dir_path, 'unsafe.txt'), encoding='utf-8') as f:
-	unsafe_facts = [
-		fact.rstrip('\r\n ')
-		for fact in f.readlines()
-		if fact.rstrip('\r\n ') != ''
-	]
+with (dir_path / "unsafe.txt").open(encoding="utf-8") as f:
+	unsafe_facts = [fact.rstrip("\r\n ") for fact in f if fact.rstrip("\r\n ")]
 
 all_facts = safe_facts + unsafe_facts
 
@@ -27,20 +27,19 @@ def get_fact(filter_enabled: bool = True, only_unsafe: bool = False) -> str:
 	Parameters
 	----------
 	filter_enabled : bool
-		The `filter_enabled` parameter determines if the function will filter
-		out potentially inappropriate facts. Defaults to True.
+			The `filter_enabled` parameter determines if the function will filter
+			out potentially inappropriate facts. Defaults to True.
 
 	only_unsafe : bool
-		The `only_unsafe` parameter determines if the function will only give
-		unsafe (NSFW) facts. Takes precedence over the `filter_enabled` argument.
+			The `only_unsafe` parameter determines if the function will only give
+			unsafe (NSFW) facts. Takes precedence over the `filter_enabled` argument.
 
-	Returns
+	Returns:
 	------
 	str
-		A random fact.
+			A random fact.
 
 	"""
-
 	if only_unsafe:
 		return choice(unsafe_facts)
 	if filter_enabled is False:
@@ -48,37 +47,46 @@ def get_fact(filter_enabled: bool = True, only_unsafe: bool = False) -> str:
 	return choice(safe_facts)
 
 
-def _cli_entrypoint():
+def _cli_entrypoint() -> None:
 	"""Entrypoint for execution via command-line."""
-
 	parser = argparse.ArgumentParser(
-		description='Generate random facts from the command-line'
+		description="Generate random facts from the command-line",
+	)
+
+	parser.add_argument(
+		"-V",
+		"--version",
+		action="store_true",
+		help="Print the package version and exit",
 	)
 
 	group = parser.add_mutually_exclusive_group()
 	group.add_argument(
-		'-m',
-		'--mixed',
-		action='store_true',
-		help='Include safe and unsafe facts'
+		"-m",
+		"--mixed",
+		action="store_true",
+		help="Include safe and unsafe facts",
 	)
 
 	group.add_argument(
-		'-u',
-		'--unsafe',
-		action='store_true',
-		help='Only include unsafe facts'
+		"-u",
+		"--unsafe",
+		action="store_true",
+		help="Only include unsafe facts",
 	)
 
 	args = parser.parse_args()
 
-	if args.mixed:
-		print(get_fact(False))
-	elif args.unsafe:
+	if args.version:  # pyright: ignore[reportAny]
+		print(__version__)
+		return
+	if args.mixed:  # pyright: ignore[reportAny]
+		print(get_fact(filter_enabled=False))
+	elif args.unsafe:  # pyright: ignore[reportAny]
 		print(get_fact(only_unsafe=True))
 	else:
 		print(get_fact())
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
 	_cli_entrypoint()

randfacts/safe.txt

@@ -378,7 +378,7 @@ Whales can suffer from sunburns
 In 2015, a U.S. journalist was sentenced to 5 years in jail for posting a link on the web
 South Koreans drink twice as much alcohol as Russians
 A newborn baby has about one cup of blood in his body.
-4%of women in the U.S. are pregnant right now
+4% of women in the U.S. are pregnant right now
 The world's longest hangover lasted 4 weeks after a Scotsman consumed 60 pints of beer.
 In 1962, John F Kennedy secretly installed a taping system in the White House.
 Men with shaved heads are perceived as an inch taller and 13% stronger than men with hair.
@@ -1269,7 +1269,7 @@ Having an orgasm at least 3 times a week cuts in half the likelihood of coronary
 30 million people in China live on less than US$1 per day, as of 2019.
 Brazil is defined as a "federal republic" composed of the Federal District, 26 states, and 5,570 municipalities.
 People with autism are less likely to catch yawns. The more severe their condition, the less common the behavior gets.
-Mexico has68 official languages.
+Mexico has 68 official languages.
 Girls who complete secondary school are 6 times less likely to become child brides
 La Paz, Bolivia, was the first South American city to get an electricity supply. It was powered by llama dung
 Penguins have an organ near the eye that filters salt from the water out of their system
@@ -4397,7 +4397,6 @@ To escape the grip of a crocodile's jaws, push your thumbs into its eyeballs –
 Reindeer like to eat bananas.
 More people are killed annually by donkeys than airplane crashes.
 Because of the rotation of the earth, an object can be thrown farther if it is thrown west.
-The average person spends 6 months of their life sitting at red lights.
 More Monopoly money is printed in a year, than real money throughout the world.
 Caesar salad has nothing to do with any of the Caesars. It was first concocted in a bar in Tijuana, Mexico, in the 1920′s.
 Seattle's Fremont Bridge rises up and down more than any drawbridge in the world.
@@ -5077,7 +5076,6 @@ Many insects can carry 50 times their own body weight. This would be like an adu
 There are over a million described species of insects. Some people estimate there are actually between 15 and 30 million species.
 Most insects are beneficial to people because they eat other insects, pollinate crops, are food for other animals, make products we use (like honey and silk) or have medical uses.
 Butterflies and insects have their skeletons on the outside of their bodies, called the exoskeleton. This protects the insect and keeps water inside their bodies so they don't dry out.
-Elephants are the only mammals that cannot jump.
 11% of the world is left-handed.
 A healthy (non-colorblind) human eye can distinguish between 500 shades of gray.
 Lizards can self-amputate their tails for protection. It grows back after a few months.
@@ -5758,7 +5756,6 @@ Up to 20% of power outages in the U.S are due to squirrels.
 The Mayo Clinic made glow in the dark cats while trying to find a cure for AIDS.
 The Antarctic glaciers are made up of 3% penguin urine.
 The happiest prisoner on death row had an IQ of 46.
-Violin bows are made from horsehair.
 IKEA is an acronym.
 Stephen Hawking held a reception for time travelers in 2009.
 A Norwegian Island made dying illegal.
@@ -6212,7 +6209,6 @@ The largest known volcano in the solar system is Olympus Mons, located on Mars.
 On Mars, sunsets appear blue due to the way light is captured in the atmosphere.
 Because there is no atmosphere, wind, or water to erode them, astronaut footprints on the moon will likely remain there for hundreds of millions of years.
 One spacesuit for a NASA astronaut costs $12 million to make.
-Uranus is the only planet to spin on its side.
 The diameter of Pluto is smaller than the horizontal length of the United States.
 The Kármán line, the invisible boundary that officially separates Earth from outer space, is located 62 miles above sea level. So you're only about 62 miles from space right now!
 It's impossible to burp in space. The lack of gravity in space prevents air in your stomach from separating and rising up from food you've eaten.
@@ -6502,7 +6498,6 @@ If Barbie were life-size, her measurements would be 39-23-33. She would stand 7
 On average, people fear spiders more than they do death.
 Thirty-five percent of the people who use personal ads for dating are already married.
 In Tokyo you can buy a toupee for your dog.
-A dime has 118 ridges around the edge.
 The world's oldest wooden wheel has been around for more than 5,000 years
 Dead skin cells are a main ingredient in household dust
 Sudan has more pyramids than any country in the world
@@ -6714,7 +6709,6 @@ NFL refs also get Super Bowl rings.
 President Hubert Hoover invented a game called "Hooverball" which was a cross between tennis and volleyball and was played with a medicine ball.
 Only one city has won three major championships in one year. In 1935, the Detroit Lions won the Super Bowl, the Tigers won the world series, and the Red Wings won the Stanley Cup.
 More than 100 baseballs are used during a typical professional baseball game.
-You can't hum while plugging your nose.
 Tomatoes have more genes than humans.
 We're one to two centimeters taller in the morning than at night.
 One quarter of all our bones are in our feet.
@@ -6761,7 +6755,7 @@ Turns out, a dog's paw print is just as unique as a human's. Good news for dog d
 A camel can drink up to 40 gallons of water in one go. That's seriously impressive!
 Don't bring your crystal ball to Maryland! Fortune telling is illegal in the state.
 Speaking of ferrets, did you know they used to be used to protect grain stores from rodents?
-The technical term for a fear of long words is ""hippopotomonstrosesquippedaliophobia." No way you can self-diagnose yourself with that one!
+The technical term for a fear of long words is "hippopotomonstrosesquippedaliophobia." No way you can self-diagnose yourself with that one!
 The White House has 35 bathrooms. So every bathroom break can be different for POTUS!
 Greyhounds can run up to 45 mph. So don't challenge one to a race!
 Hiking naked is illegal in Switzerland. Though we must say, it doesn't seem like a good idea in general!
@@ -7020,7 +7014,6 @@ Rubber bands last longer when refrigerated.
 Since 1896, the beginning of the modern Olympics, only Greece and Australia have participated in every Games.
 The average person has over 1,460 dreams a year.
 The band Duran Duran got their name from an astronaut in the 1968 Jane Fonda movie Barbarella.
-The Earth weighs around 6,588,000,000,000,000,000,000,000 tons.
 The first toilet ever seen on television was on "Leave It To Beaver."
 The international telephone dialing code for Antarctica is 672.
 The name "Jeep" came from the abbreviation used in the army for the "general purpose" vehicle, G.P.
@@ -7164,7 +7157,6 @@ Only animal besides a human that can get sunburn: a pig.
 Proportional to their weight, men are stronger than horses.
 It is believed that Shakespeare was 46 around the time that the King James Version of the Bible was written. In Psalms 46, the 46th word from the first word is "shake," and the 46th word from the last word is "spear."
 The parachute was invented by Leonardo da Vinci in 1515.
-"Canada" is a Native American word meaning "big village."
 The symbol on the "pound" key (#) is called an octothorpe.
 A full 7% of the entire Irish barley crop goes to the production of Guinness beer.
 Tigers have striped skin, not just striped fur.
@@ -7349,4 +7341,4 @@ The shortest commercial flight in the world is in Scotland.
 Dolphins have names for one another.
 The blob of toothpaste on a toothbrush has a name - a nurdle.
 One part of Istanbul is in Europe and the other is in Asia.
-There are more than 1,000 types of bananas growing in the world.
+There are more than 1,000 types of bananas growing in the world.

randfacts/unsafe.txt

@@ -112,4 +112,4 @@ During the medieval times (circa 1400s), France had impotency trials. Which allo
 Dildos have been around for centuries. With the oldest potential dildo being 28,000 years old.
 Vibrators were created in the 19th century to reduce "hysteria" in women.
 Famous gangster, Al Capone, had undiagnosed syphillis until he went to prison.
-According to a British law passed in 1845, attempting to commit suicide was a capital offense. Offenders could be hanged for trying.
+According to a British law passed in 1845, attempting to commit suicide was a capital offense. Offenders could be hanged for trying.

randfacts-0.21.0.dist-info/LICENSE.txt → randfacts-0.22.0.dist-info/LICENSE

@@ -1,5 +1,5 @@
 MIT License
-Copyright (c) 2020-2021 Connor Sample
+Copyright (c) 2020-2024 Connor Sample
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
@@ -14,4 +14,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

{randfacts-0.21.0.dist-info → randfacts-0.22.0.dist-info}/METADATA

@@ -1,10 +1,17 @@
 Metadata-Version: 2.1
 Name: randfacts
-Version: 0.21.0
+Version: 0.22.0
 Summary: Package to generate random facts
-Home-page: https://github.com/TabulateJarl8/randfacts
-Author: Tabulate
+Home-page: https://tabulate.tech/software/randfacts/
+License: MIT
+Author: TabulateJarl8
 Author-email: tabulatejarl8@gmail.com
+Requires-Python: >=3.6,<4.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 3.7
@@ -13,14 +20,9 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Classifier: Natural Language :: English
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Intended Audience :: Developers
-Requires-Python: >=3.6
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Project-URL: Repository, https://github.com/TabulateJarl8/randfacts
 Description-Content-Type: text/markdown
-License-File: LICENSE.txt
 
 <p align="center">
 <img src="https://raw.githubusercontent.com/TabulateJarl8/randfacts/master/imgs/logo-embedded-font.svg" />
@@ -118,3 +120,4 @@ More help.
 ```sh
 $ python3 -m randfacts --help
 ```
+

randfacts-0.22.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+randfacts/__init__.py,sha256=AIc-PGGpuk2zNraanv5kum3JyWNV2ba3HSzPcX56PYs,1615
+randfacts/__main__.py,sha256=sH6dc3zI2TSF12PVQTp_mlCPgKrF-7lJd_8kQ8hZ2S0,97
+randfacts/randfacts.py,sha256=KvK5BVw4qykbz5X6Lb3YqAXimH-7YtlXA3lWyHJJHcw,2197
+randfacts/safe.txt,sha256=qNQQ9W00vUjaF1Gma-sqWKGYQRbCegP-GrrDNpFvsY4,634851
+randfacts/unsafe.txt,sha256=6CO4QTQ7YIqkDyyS9cbV1-eqs8B0TYxzDyab4lUGGHQ,10415
+randfacts-0.22.0.dist-info/LICENSE,sha256=Pw9YWaR5pSAfnfuabUSytyJGj2Wy4G7Zw1EdldX9KGU,1088
+randfacts-0.22.0.dist-info/METADATA,sha256=yzWaFBEbBO6Ytxgm-0mQ8dD0rC8qVi80v2C30I83RCM,4687
+randfacts-0.22.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+randfacts-0.22.0.dist-info/entry_points.txt,sha256=YPadKZhBZjJaNq_Mfkaj7HJgs63rf3rl_7pj5Tf8WY8,65
+randfacts-0.22.0.dist-info/RECORD,,

{randfacts-0.21.0.dist-info → randfacts-0.22.0.dist-info}/WHEEL

@@ -1,5 +1,4 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.40.0)
+Generator: poetry-core 1.9.0
 Root-Is-Purelib: true
 Tag: py3-none-any
-

randfacts-0.22.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+randfacts=randfacts.randfacts:_cli_entrypoint
+

randfacts/__version__.py

@@ -1,8 +0,0 @@
-__title__ = "randfacts"
-__description__ = "Package to generate random facts"
-__url__ = "https://github.com/TabulateJarl8/randfacts"
-__version__ = "0.21.0"
-__author__ = "Tabulate"
-__author_email__ = "tabulatejarl8@gmail.com"
-__license__ = "MIT"
-__copyright__ = "Copyright 2020-2023 Connor Sample"

randfacts-0.21.0.dist-info/RECORD

@@ -1,11 +0,0 @@
-randfacts/__init__.py,sha256=yTaySH_8eS772eD6wCi-GLl-tekVRqiRjjbvF4SXocc,1583
-randfacts/__main__.py,sha256=Ng4WikgLUpvoIqIfJ_ZZtNyoxS6pUdXtmA_XD4tW_L0,56
-randfacts/__version__.py,sha256=7pIJXuFVcrjhV20rrYHh0Ef0wr22XbFKZ4sBaELJSuM,296
-randfacts/randfacts.py,sha256=AcY65AdKtZhTvZkCEuTFmDE_kpHtjyr0LcKgVkGJDbI,1775
-randfacts/safe.txt,sha256=3y_P1DQPPTdoEd8ECc7BT-c4SRhPcUtNC0-4OmvPgb8,635255
-randfacts/unsafe.txt,sha256=fhnpoF9qHQf_nd3spkn3AEtDxuj5zMI1BFkNXWQ8c1A,10414
-randfacts-0.21.0.dist-info/LICENSE.txt,sha256=jxhCPqBHN7biBPbFOa4AHqFoT1P37hYZyA2MREV1VBM,1086
-randfacts-0.21.0.dist-info/METADATA,sha256=6-r5O9VWq5DYQrsjvyU_cUUv4ayPWevPCAr8U7xPjEU,4549
-randfacts-0.21.0.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
-randfacts-0.21.0.dist-info/top_level.txt,sha256=CtuA0wZECn98oIjL-EgzBRN804oPMLtAPPpM0KJbWIU,10
-randfacts-0.21.0.dist-info/RECORD,,

randfacts-0.21.0.dist-info/top_level.txt

@@ -1 +0,0 @@
-randfacts