Simyan 2.0.0__tar.gz → 3.0.0__tar.gz

{simyan-2.0.0 → simyan-3.0.0}/.gitignore

@@ -2,6 +2,7 @@
 __pycache__/
 __pypackages__/
 .idea/
+.pytest_cache/
 .ruff_cache/
 .tox/
 .venv/

{simyan-2.0.0 → simyan-3.0.0}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: Simyan
-Version: 2.0.0
+Version: 3.0.0
 Summary: A Python wrapper for the Comicvine API.
 Project-URL: Documentation, https://simyan.readthedocs.io/en/stable/
 Project-URL: Homepage, https://pypi.org/project/Simyan
 Project-URL: Issues, https://github.com/Metron-Project/Simyan/issues
 Project-URL: Source, https://github.com/Metron-Project/Simyan
-Author-email: BuriedInCode <BuriedInCode@tuta.io>
-Maintainer-email: BuriedInCode <BuriedInCode@tuta.io>
+Author-email: BuriedInCode <buriedincode@duckpond.nz>
+Maintainer-email: BuriedInCode <buriedincode@duckpond.nz>
 License-Expression: GPL-3.0-or-later
 License-File: LICENSE
 Keywords: comic,comics,metadata
@@ -26,9 +26,10 @@ Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Internet
 Classifier: Typing :: Typed
 Requires-Python: >=3.10
-Requires-Dist: httpx>=0.28.0
-Requires-Dist: pydantic>=2.12.0
-Requires-Dist: pyrate-limiter>=4.0.0
+Requires-Dist: pydantic>=2.13.0
+Requires-Dist: requests-cache>=1.3.0
+Requires-Dist: requests-ratelimiter>=0.10.0
+Requires-Dist: requests>=2.34.0
 Description-Content-Type: text/markdown
 
 # Simyan
@@ -38,8 +39,9 @@ Description-Content-Type: text/markdown
 [![PyPI - Version](https://img.shields.io/pypi/v/Simyan.svg?logo=Python&label=Version&style=flat-square)](https://pypi.python.org/pypi/Simyan/)
 [![PyPI - License](https://img.shields.io/pypi/l/Simyan.svg?logo=Python&label=License&style=flat-square)](https://opensource.org/licenses/GPL-3.0)
 
-[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-informational?logo=pre-commit&style=flat-square)](https://github.com/pre-commit/pre-commit)
-[![Ruff](https://img.shields.io/badge/ruff-enabled-informational?logo=ruff&style=flat-square)](https://github.com/astral-sh/ruff)
+[![prek](https://img.shields.io/badge/prek-enabled-informational?logo=prek&style=flat-square)](https://github.com/j178/prek)
+[![Ruff](https://img.shields.io/badge/Ruff-enabled-informational?logo=ruff&style=flat-square)](https://github.com/astral-sh/ruff)
+[![ty](https://img.shields.io/badge/ty-enabled-informational?logo=ruff&style=flat-square)](https://github.com/astral-sh/ty)
 
 [![Linting](https://github.com/Metron-Project/Simyan/actions/workflows/linting.yaml/badge.svg)](https://github.com/Metron-Project/Simyan/actions/workflows/linting.yaml)
 [![Testing](https://github.com/Metron-Project/Simyan/actions/workflows/testing.yaml/badge.svg)](https://github.com/Metron-Project/Simyan/actions/workflows/testing.yaml)
@@ -57,10 +59,19 @@ pip install Simyan
 ### Example Usage
 
 ```python
-from simyan.cache import SQLiteCache
+from datetime import timedelta
+from pathlib import Path
+
 from simyan.comicvine import Comicvine
 
-session = Comicvine(api_key="Comicvine API Key", cache=SQLiteCache())
+session = Comicvine(
+    api_key="Comicvine API Key",
+    cache_path=Path("cache.sqlite"),  # Optional, defaults to ~/.cache/simyan/cache.sqlite
+    cache_expiry=timedelta(days=1),  # Optional, defaults to 14 days
+    ratelimit_path=Path(
+        "ratelimits.sqlite"
+    ),  # Optional, defaults to ~/.cache/simyan/ratelimits.sqlite
+)
 
 # Search for Publisher
 results = session.list_publishers(params={"filter": "name:DC Comics"})

{simyan-2.0.0 → simyan-3.0.0}/README.md

@@ -5,8 +5,9 @@
 [![PyPI - Version](https://img.shields.io/pypi/v/Simyan.svg?logo=Python&label=Version&style=flat-square)](https://pypi.python.org/pypi/Simyan/)
 [![PyPI - License](https://img.shields.io/pypi/l/Simyan.svg?logo=Python&label=License&style=flat-square)](https://opensource.org/licenses/GPL-3.0)
 
-[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-informational?logo=pre-commit&style=flat-square)](https://github.com/pre-commit/pre-commit)
-[![Ruff](https://img.shields.io/badge/ruff-enabled-informational?logo=ruff&style=flat-square)](https://github.com/astral-sh/ruff)
+[![prek](https://img.shields.io/badge/prek-enabled-informational?logo=prek&style=flat-square)](https://github.com/j178/prek)
+[![Ruff](https://img.shields.io/badge/Ruff-enabled-informational?logo=ruff&style=flat-square)](https://github.com/astral-sh/ruff)
+[![ty](https://img.shields.io/badge/ty-enabled-informational?logo=ruff&style=flat-square)](https://github.com/astral-sh/ty)
 
 [![Linting](https://github.com/Metron-Project/Simyan/actions/workflows/linting.yaml/badge.svg)](https://github.com/Metron-Project/Simyan/actions/workflows/linting.yaml)
 [![Testing](https://github.com/Metron-Project/Simyan/actions/workflows/testing.yaml/badge.svg)](https://github.com/Metron-Project/Simyan/actions/workflows/testing.yaml)
@@ -24,10 +25,19 @@ pip install Simyan
 ### Example Usage
 
 ```python
-from simyan.cache import SQLiteCache
+from datetime import timedelta
+from pathlib import Path
+
 from simyan.comicvine import Comicvine
 
-session = Comicvine(api_key="Comicvine API Key", cache=SQLiteCache())
+session = Comicvine(
+    api_key="Comicvine API Key",
+    cache_path=Path("cache.sqlite"),  # Optional, defaults to ~/.cache/simyan/cache.sqlite
+    cache_expiry=timedelta(days=1),  # Optional, defaults to 14 days
+    ratelimit_path=Path(
+        "ratelimits.sqlite"
+    ),  # Optional, defaults to ~/.cache/simyan/ratelimits.sqlite
+)
 
 # Search for Publisher
 results = session.list_publishers(params={"filter": "name:DC Comics"})

{simyan-2.0.0 → simyan-3.0.0}/docs/index.md

@@ -5,8 +5,9 @@
 [![PyPI - Version](https://img.shields.io/pypi/v/Simyan.svg?logo=Python&label=Version&style=flat-square)](https://pypi.python.org/pypi/Simyan/)
 [![PyPI - License](https://img.shields.io/pypi/l/Simyan.svg?logo=Python&label=License&style=flat-square)](https://opensource.org/licenses/GPL-3.0)
 
-[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-informational?logo=pre-commit&style=flat-square)](https://github.com/pre-commit/pre-commit)
-[![Ruff](https://img.shields.io/badge/ruff-enabled-informational?logo=ruff&style=flat-square)](https://github.com/astral-sh/ruff)
+[![prek](https://img.shields.io/badge/prek-enabled-informational?logo=prek&style=flat-square)](https://github.com/j178/prek)
+[![Ruff](https://img.shields.io/badge/Ruff-enabled-informational?logo=ruff&style=flat-square)](https://github.com/astral-sh/ruff)
+[![ty](https://img.shields.io/badge/ty-enabled-informational?logo=ruff&style=flat-square)](https://github.com/astral-sh/ty)
 
 [![Linting](https://github.com/Metron-Project/Simyan/actions/workflows/linting.yaml/badge.svg)](https://github.com/Metron-Project/Simyan/actions/workflows/linting.yaml)
 [![Testing](https://github.com/Metron-Project/Simyan/actions/workflows/testing.yaml/badge.svg)](https://github.com/Metron-Project/Simyan/actions/workflows/testing.yaml)
@@ -24,10 +25,19 @@ pip install Simyan
 ### Example Usage
 
 ```python
-from simyan.cache import SQLiteCache
+from datetime import timedelta
+from pathlib import Path
+
 from simyan.comicvine import Comicvine
 
-session = Comicvine(api_key="Comicvine API Key", cache=SQLiteCache())
+session = Comicvine(
+    api_key="Comicvine API Key",
+    cache_path=Path("cache.sqlite"),  # Optional, defaults to ~/.cache/simyan/cache.sqlite
+    cache_expiry=timedelta(days=1),  # Optional, defaults to 14 days
+    ratelimit_path=Path(
+        "ratelimits.sqlite"
+    ),  # Optional, defaults to ~/.cache/simyan/ratelimits.sqlite
+)
 
 # Search for Publisher
 results = session.list_publishers(params={"filter": "name:DC Comics"})
@@ -47,8 +57,3 @@ print(result.summary)
 ## Bugs/Requests
 
 Please use the [GitHub issue tracker](https://github.com/Metron-Project/Simyan/issues) to submit bugs or request features.
-
-## Contributing
-
-- When running a new test for the first time, set the environment variable `COMICVINE__API_KEY` to your Comicvine API key.
-  The responses will be cached in the `tests/cache.sqlite` database without your key.

simyan-3.0.0/prek.toml

@@ -0,0 +1,53 @@
+[[repos]]
+hooks = [
+  {args = ["--all", "--in-place"], entry = "toml-sort", exclude = ".*.lock", id = "toml-sort", language = "system", name = "toml sort", types = ["toml"]},
+  {args = ["--number", "--wrap=keep"], entry = "mdformat", exclude = "(.github/ISSUE_TEMPLATE/.*|docs/simyan/schemas/_base).md", id = "mdformat", language = "system", name = "mdformat", types = ["markdown"]},
+  {entry = "ruff check .", id = "ruff-check", language = "system", name = "ruff check", pass_filenames = false, types = ["python"]},
+  {entry = "ruff format .", id = "ruff-format", language = "system", name = "ruff format", pass_filenames = false, types = ["python"]},
+  {entry = "ty check .", id = "ty", language = "system", name = "ty", pass_filenames = false, types = ["python"]},
+]
+repo = "local"
+
+[[repos]]
+hooks = [
+  {args = ["--allow-multiple-documents"], id = "check-yaml"},
+  {args = ["--assume-in-merge"], id = "check-merge-conflict"},
+  {args = ["--markdown-linebreak-ext=md"], id = "trailing-whitespace"},
+  {exclude_types = ["json", "svg", "xml"], id = "end-of-file-fixer"},
+  {id = "check-added-large-files"},
+  {id = "check-case-conflict"},
+  {id = "check-executables-have-shebangs"},
+  {id = "check-json"},
+  {id = "check-json5"},
+  {id = "check-symlinks"},
+  {id = "check-toml"},
+  {id = "check-xml"},
+  {id = "detect-private-key"},
+  {id = "fix-byte-order-marker"},
+  {id = "mixed-line-ending"},
+]
+repo = "builtin"
+
+[[repos]]
+hooks = [
+  {args = ["--autofix", "--indent=2"], id = "pretty-format-json"},
+  {id = "check-ast"},
+  {id = "check-builtin-literals"},
+  {id = "check-docstring-first"},
+  {id = "check-illegal-windows-names"},
+  {id = "check-merge-conflict"},
+  {id = "check-shebang-scripts-are-executable"},
+  {id = "check-vcs-permalinks"},
+  {id = "debug-statements"},
+  {id = "forbid-submodules"},
+  {id = "name-tests-test"},
+]
+repo = "https://github.com/pre-commit/pre-commit-hooks"
+rev = "v6.0.0"
+
+[[repos]]
+hooks = [
+  # {id = "check-hooks-apply"},
+  {id = "check-useless-excludes"},
+]
+repo = "meta"