randfacts 0.20.2__tar.gz → 0.23.0__tar.gz

randfacts-0.20.2/LICENSE.txt → randfacts-0.23.0/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.20.2 → randfacts-0.23.0}/PKG-INFO

@@ -1,12 +1,17 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: randfacts
-Version: 0.20.2
+Version: 0.23.0
 Summary: Package to generate random facts
-Home-page: https://github.com/TabulateJarl8/randfacts
-Author: Tabulate
+License: MIT
+License-File: LICENSE
+Author: TabulateJarl8
 Author-email: tabulatejarl8@gmail.com
-License: UNKNOWN
-Platform: UNKNOWN
+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
@@ -14,14 +19,14 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-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: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: importlib-metadata (>=1.4,<2.0) ; python_version < "3.8"
+Project-URL: Homepage, https://tabulate.tech/software/randfacts/
+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" />
@@ -36,6 +41,7 @@ License-File: LICENSE.txt
 	<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>
+	<a href="https://codecov.io/gh/TabulateJarl8/randfacts"><img src="https://codecov.io/gh/TabulateJarl8/randfacts/graph/badge.svg?token=HUQJ88VXLQ"/></a>
 	<br>
 	<a href="https://ko-fi.com/L4L3L7IO2"><img alt="Kofi Badge" src="https://ko-fi.com/img/githubbutton_sm.svg" /></a>
 </p>
@@ -120,4 +126,3 @@ More help.
 $ python3 -m randfacts --help
 ```
 
-

{randfacts-0.20.2 → randfacts-0.23.0}/README.md

@@ -11,6 +11,7 @@
 	<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>
+	<a href="https://codecov.io/gh/TabulateJarl8/randfacts"><img src="https://codecov.io/gh/TabulateJarl8/randfacts/graph/badge.svg?token=HUQJ88VXLQ"/></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-0.23.0/pyproject.toml

@@ -0,0 +1,133 @@
+[tool.poetry]
+name = "randfacts"
+version = "0.23.0"
+description = "Package to generate random facts"
+authors = ["TabulateJarl8 <tabulatejarl8@gmail.com>"]
+license = "MIT"
+readme = "README.md"
+include = ["randfacts/*.txt"]
+homepage = "https://tabulate.tech/software/randfacts/"
+repository = "https://github.com/TabulateJarl8/randfacts"
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.6",
+  "Programming Language :: Python :: 3.7",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Natural Language :: English",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+  "Development Status :: 5 - Production/Stable",
+  "Intended Audience :: Developers",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+]
+packages = [{ include = 'randfacts' }]
+
+[tool.poetry.scripts]
+randfacts = 'randfacts.randfacts:_cli_entrypoint'
+
+[tool.pyright]
+reportUnusedCallResult = false
+
+[tool.ruff.lint]
+preview = true
+select = ["ALL"]
+
+ignore = [
+  # complains about tab indentation
+  "W191",
+  "D206",
+  # adds a line break before a class docstring
+  "D203",
+  # puts the first line summary of a docstring on a different line than the """
+  "D213",
+  # tries to add a blank line after the last docstring section
+  "D413",
+  # yells at you if you use a bool typed function argument
+  "FBT001",
+  "FBT002",
+  # yells at you for using try-except in a for loop
+  "PERF203",
+  # allow for the use of Any
+  "ANN401",
+  # false positives for overriding methods (i think)
+  "PLR6301",
+  # disable too many branches check
+  "PLR0912",
+  # copyright at top of file
+  "CPY",
+  # complains about random.choice() not being good for cryptography
+  "S311",
+]
+
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = [
+  "S101",
+  "ANN001",
+  "ANN002",
+  "PLC2701",
+  "ARG002",
+  "PLR2004",
+  "DOC",
+  "INP001",
+  "S",
+]
+"randfacts/randfacts.py" = ["T201"]
+"randfacts/__main__.py" = ["D100"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "tab"
+line-ending = "lf"
+
+[tool.ruff.lint.isort]
+combine-as-imports = true
+force-wrap-aliases = true
+order-by-type = true
+
+[tool.poetry.dependencies]
+python = "^3.6"
+importlib-metadata = { version = "^1.4", python = "<3.8" }
+
+[tool.poetry.group.dev.dependencies]
+ruff = [
+  { version = "^0.14.11", python = "^3.9" },
+  { version = "^0.7.4", python = ">=3.7,<3.9" },
+]
+pytest = [
+  { version = "^9.0.2", python = "^3.10" },
+  { version = "^8.3.3", python = ">=3.9,<3.10" },
+  { version = "^6.2.0", python = ">=3.6,<3.8" },
+]
+pytest-cov = [
+  { version = "^7.0.0", python = "^3.9" },
+  { version = "^5.0.0", python = ">=3.8,<3.9" },
+  { version = "^4.0.0", python = ">=3.6,<3.8" },
+]
+mypy = [
+  { version = "^1.19.1", python = "^3.9" },
+  { version = "~1.14.0", python = ">=3.8,<3.9" },
+  { version = "~1.4.0", python = ">=3.7,<3.8" },
+]
+
+[tool.coverage.run]
+omit = ["randfacts/__main__.py"]
+
+# legacy import: ingore types
+[tool.mypy]
+[[tool.mypy.overrides]]
+module = "importlib_metadata.*"
+ignore_missing_imports = true
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

randfacts-0.23.0/randfacts/__init__.py

@@ -0,0 +1,57 @@
+"""Module to generate random facts.
+
+randfacts provides an interface to a list of facts installed with the module.
+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.
+
+				Generate a random SFW (safe for work) fact.
+
+						>>> randfacts.get_fact()
+
+				Generate a random NSFW (not safe for work) fact.
+
+						>>> randfacts.get_fact(only_unsafe=True)
+
+				Generate a random mixed fact (possibility of both SFW and NSFW facts)
+
+						>>> randfacts.get_fact(filter_enabled=False)
+
+CLI Examples:
+		randfacts can be executed via the command line with the following commands:
+
+		Normal execution; only safe facts
+
+				$ python3 -m randfacts
+
+		The unsafe argument can be supplied to provide only unsafe facts
+
+				$ python3 -m randfacts --unsafe
+
+		The mixed argument can be provided to provide both SFW and NSFW facts.
+
+				$ python3 -m randfacts --mixed
+
+		More help.
+
+				$ python3 -m randfacts --help
+
+"""
+
+from randfacts.randfacts import (
+	__version__,
+	all_facts,
+	get_fact,
+	safe_facts,
+	unsafe_facts,
+)
+
+__all__ = [
+	"__version__",
+	"all_facts",
+	"get_fact",
+	"safe_facts",
+	"unsafe_facts",
+]

randfacts-0.23.0/randfacts/__main__.py

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

randfacts-0.23.0/randfacts/randfacts.py

@@ -0,0 +1,94 @@
+"""Contains the core functionality of randfacts."""
+
+import argparse
+import sys
+from pathlib import Path
+from random import choice
+
+if sys.version_info >= (3, 8):  # noqa: UP036
+	from importlib import metadata
+else:
+	import importlib_metadata as metadata
+
+__version__: str = metadata.version("randfacts")
+
+dir_path = Path(__file__).resolve().parent
+
+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 (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
+
+
+def get_fact(filter_enabled: bool = True, only_unsafe: bool = False) -> str:
+	"""This function returns a random fact.
+
+	Parameters
+	----------
+	filter_enabled : bool
+			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.
+
+	Returns:
+	------
+	str
+			A random fact.
+
+	"""
+	if only_unsafe:
+		return choice(unsafe_facts)
+	if not filter_enabled:
+		return choice(all_facts)
+	return choice(safe_facts)
+
+
+def _cli_entrypoint() -> None:
+	"""Entrypoint for execution via command-line."""
+	parser = argparse.ArgumentParser(
+		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",
+	)
+
+	group.add_argument(
+		"-u",
+		"--unsafe",
+		action="store_true",
+		help="Only include unsafe facts",
+	)
+
+	args = parser.parse_args()
+
+	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__":
+	_cli_entrypoint()