stsdb 0.1.1__tar.gz

stsdb-0.1.1/PKG-INFO

@@ -0,0 +1,102 @@
+Metadata-Version: 2.4
+Name: stsdb
+Version: 0.1.1
+Summary: Deterministic Slay the Spire card and relic query toolset
+Author: Taardisaa
+License: MIT
+Keywords: slay-the-spire,database,cards,relics
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# Slay the Spire Database (stsdb)
+
+A card/relic query toolset for [Slay the Spire](https://www.megacrit.com/).
+
+It exposes two main commands:
+
+- `query_card`: query card metadata, with optional upgrade level.
+- `query_relic`: query relic metadata.
+
+Both commands use exact name matching only (no fuzzy match, no partial match, no fallback).
+
+`query_card` also supports `upgrade_times`:
+
+- Most cards: capped at one applied upgrade.
+- `Searing Blow`: supports unbounded upgrades using the in-game scaling rule.
+
+## Installation
+
+```bash
+pip install stsdb
+```
+
+Dev installation:
+
+```bash
+pip install -e .
+```
+
+### Usage
+
+```bash
+stsdb query_card "Bash"
+stsdb query_card "Searing Blow" --upgrade-times 3
+stsdb query_relic "Burning Blood"
+python -m stsdb query_card "Bash"
+```
+
+### Python API
+
+```python
+import stsdb
+from stsdb import query_card, query_relic
+
+stsdb.query_card("Bash")
+query_card("Bash")
+query_card("Searing Blow", upgrade_times=3)
+query_relic("Burning Blood")
+```
+
+### Local development
+
+Install in development mode:
+
+```bash
+pip install -e .
+```
+
+Run tests:
+
+```bash
+python -m unittest discover -s tests -v
+```
+
+### Output
+
+- Success: `{"found": true, "entry": {...}}`
+- Card miss: `{"found": false, "error": "CARD_NOT_FOUND"}`
+- Invalid upgrade input: `{"found": false, "error": "INVALID_UPGRADE_TIMES"}`
+- Relic miss: `{"found": false, "error": "RELIC_NOT_FOUND"}`
+
+## Other Notes
+
+Data files are shipped inside the package under `stsdb/data/`:
+
+- `card.csv`
+- `relic.csv`
+- `hero.csv`
+- `play.csv`
+- `relic_availability.csv`
+- `card_upgrade.csv`
+
+Upgrade metadata format (`card_upgrade.csv`):
+
+- `nameCard;hasUpgrade;costUpgraded;descriptionUpgraded`
+
+## Credits
+
+This repository is adapted from the original project by [Ferdomgar97](https://github.com/ferdomgar97/Slay-the-Spire)

stsdb-0.1.1/README.md

@@ -0,0 +1,88 @@
+# Slay the Spire Database (stsdb)
+
+A card/relic query toolset for [Slay the Spire](https://www.megacrit.com/).
+
+It exposes two main commands:
+
+- `query_card`: query card metadata, with optional upgrade level.
+- `query_relic`: query relic metadata.
+
+Both commands use exact name matching only (no fuzzy match, no partial match, no fallback).
+
+`query_card` also supports `upgrade_times`:
+
+- Most cards: capped at one applied upgrade.
+- `Searing Blow`: supports unbounded upgrades using the in-game scaling rule.
+
+## Installation
+
+```bash
+pip install stsdb
+```
+
+Dev installation:
+
+```bash
+pip install -e .
+```
+
+### Usage
+
+```bash
+stsdb query_card "Bash"
+stsdb query_card "Searing Blow" --upgrade-times 3
+stsdb query_relic "Burning Blood"
+python -m stsdb query_card "Bash"
+```
+
+### Python API
+
+```python
+import stsdb
+from stsdb import query_card, query_relic
+
+stsdb.query_card("Bash")
+query_card("Bash")
+query_card("Searing Blow", upgrade_times=3)
+query_relic("Burning Blood")
+```
+
+### Local development
+
+Install in development mode:
+
+```bash
+pip install -e .
+```
+
+Run tests:
+
+```bash
+python -m unittest discover -s tests -v
+```
+
+### Output
+
+- Success: `{"found": true, "entry": {...}}`
+- Card miss: `{"found": false, "error": "CARD_NOT_FOUND"}`
+- Invalid upgrade input: `{"found": false, "error": "INVALID_UPGRADE_TIMES"}`
+- Relic miss: `{"found": false, "error": "RELIC_NOT_FOUND"}`
+
+## Other Notes
+
+Data files are shipped inside the package under `stsdb/data/`:
+
+- `card.csv`
+- `relic.csv`
+- `hero.csv`
+- `play.csv`
+- `relic_availability.csv`
+- `card_upgrade.csv`
+
+Upgrade metadata format (`card_upgrade.csv`):
+
+- `nameCard;hasUpgrade;costUpgraded;descriptionUpgraded`
+
+## Credits
+
+This repository is adapted from the original project by [Ferdomgar97](https://github.com/ferdomgar97/Slay-the-Spire)

stsdb-0.1.1/pyproject.toml

@@ -0,0 +1,34 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "stsdb"
+version = "0.1.1"
+description = "Deterministic Slay the Spire card and relic query toolset"
+readme = "README.md"
+requires-python = ">=3.9"
+license = { text = "MIT" }
+authors = [
+  { name = "Taardisaa" }
+]
+keywords = ["slay-the-spire", "database", "cards", "relics"]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent"
+]
+
+[project.scripts]
+stsdb = "stsdb.cli:main"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["stsdb*"]
+
+[tool.setuptools.package-data]
+stsdb = ["data/*.csv"]

stsdb-0.1.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

stsdb-0.1.1/stsdb/__init__.py

@@ -0,0 +1,3 @@
+from .core import query_card, query_relic
+
+__all__ = ["query_card", "query_relic"]

stsdb-0.1.1/stsdb/__main__.py

@@ -0,0 +1,5 @@
+from .cli import main
+
+
+if __name__ == "__main__":
+    main()

stsdb-0.1.1/stsdb/cli.py

@@ -0,0 +1,35 @@
+import argparse
+import json
+
+from .core import query_card, query_relic
+
+
+def _build_parser():
+    parser = argparse.ArgumentParser(description="Deterministic exact-match query toolset")
+    subparsers = parser.add_subparsers(dest="tool", required=True)
+
+    card_parser = subparsers.add_parser("query_card", help="Query a card by exact name")
+    card_parser.add_argument("name", help="Exact card name")
+    card_parser.add_argument(
+        "--upgrade-times",
+        type=int,
+        default=0,
+        help="Requested upgrade count (default: 0)",
+    )
+
+    relic_parser = subparsers.add_parser("query_relic", help="Query a relic by exact name")
+    relic_parser.add_argument("name", help="Exact relic name")
+
+    return parser
+
+
+def main():
+    parser = _build_parser()
+    args = parser.parse_args()
+
+    if args.tool == "query_card":
+        result = query_card(args.name, args.upgrade_times)
+    else:
+        result = query_relic(args.name)
+
+    print(json.dumps(result, ensure_ascii=True))

stsdb-0.1.1/stsdb/core.py

@@ -0,0 +1,137 @@
+import csv
+from functools import lru_cache
+from importlib.resources import files
+
+
+def _normalize_cost(raw_cost: str):
+    if raw_cost == "NULL":
+        return None
+    return int(raw_cost)
+
+
+def _data_path(filename: str):
+    return files("stsdb").joinpath("data", filename)
+
+
+@lru_cache(maxsize=1)
+def _cards_by_name():
+    cards = {}
+    with _data_path("card.csv").open("r", encoding="utf-8", newline="") as f:
+        reader = csv.reader(f, delimiter=";")
+        for row in reader:
+            name, rarity, card_type, cost, description = row
+            cards[name] = {
+                "name": name,
+                "rarity": None if rarity == "NULL" else rarity,
+                "type": card_type,
+                "cost": _normalize_cost(cost),
+                "description": description,
+            }
+    return cards
+
+
+@lru_cache(maxsize=1)
+def _relics_by_name():
+    relics = {}
+    with _data_path("relic.csv").open("r", encoding="utf-8", newline="") as f:
+        reader = csv.reader(f, delimiter=";")
+        for row in reader:
+            name, rarity, description = row
+            relics[name] = {
+                "name": name,
+                "rarity": rarity,
+                "description": description,
+            }
+    return relics
+
+
+@lru_cache(maxsize=1)
+def _card_playable_by():
+    card_map = {}
+    with _data_path("play.csv").open("r", encoding="utf-8", newline="") as f:
+        reader = csv.reader(f, delimiter=";")
+        for row in reader:
+            card_name, hero_name = row
+            card_map.setdefault(card_name, []).append(hero_name)
+    return card_map
+
+
+@lru_cache(maxsize=1)
+def _card_upgrade_by_name():
+    upgrades = {}
+    with _data_path("card_upgrade.csv").open("r", encoding="utf-8", newline="") as f:
+        reader = csv.reader(f, delimiter=";")
+        for row in reader:
+            card_name, has_upgrade, cost_upgraded, description_upgraded = row
+            upgrades[card_name] = {
+                "has_upgrade": has_upgrade == "true",
+                "cost_upgraded": _normalize_cost(cost_upgraded),
+                "description_upgraded": description_upgraded,
+            }
+    return upgrades
+
+
+@lru_cache(maxsize=1)
+def _relic_available_to():
+    relic_map = {}
+    with _data_path("relic_availability.csv").open("r", encoding="utf-8", newline="") as f:
+        reader = csv.reader(f, delimiter=";")
+        for row in reader:
+            relic_name, hero_name = row
+            relic_map.setdefault(relic_name, []).append(hero_name)
+    return relic_map
+
+
+def _apply_searing_blow_upgrades(base_card, upgrade_times: int):
+    if upgrade_times <= 0:
+        return base_card
+
+    base_damage = 12
+    upgraded_damage = (upgrade_times * (upgrade_times + 7)) // 2 + base_damage
+    upgraded_description = f"Deal {upgraded_damage} damage. Can be Upgraded any number of times."
+
+    upgraded_card = dict(base_card)
+    upgraded_card["description"] = upgraded_description
+    return upgraded_card
+
+
+def query_card(name: str, upgrade_times: int = 0):
+    if upgrade_times < 0:
+        return {"found": False, "error": "INVALID_UPGRADE_TIMES"}
+
+    card = _cards_by_name().get(name)
+    if card is None:
+        return {"found": False, "error": "CARD_NOT_FOUND"}
+
+    entry = dict(card)
+    upgrade_info = _card_upgrade_by_name().get(name)
+
+    applied_upgrade_times = 0
+    max_upgrade_times = 0
+
+    if name == "Searing Blow":
+        entry = _apply_searing_blow_upgrades(entry, upgrade_times)
+        applied_upgrade_times = upgrade_times
+        max_upgrade_times = -1
+    elif upgrade_info and upgrade_info["has_upgrade"]:
+        max_upgrade_times = 1
+        if upgrade_times > 0:
+            applied_upgrade_times = 1
+            entry["cost"] = upgrade_info["cost_upgraded"]
+            entry["description"] = upgrade_info["description_upgraded"]
+
+    entry["playable_by"] = _card_playable_by().get(name, [])
+    entry["requested_upgrade_times"] = upgrade_times
+    entry["applied_upgrade_times"] = applied_upgrade_times
+    entry["max_upgrade_times"] = max_upgrade_times
+    return {"found": True, "entry": entry}
+
+
+def query_relic(name: str):
+    relic = _relics_by_name().get(name)
+    if relic is None:
+        return {"found": False, "error": "RELIC_NOT_FOUND"}
+
+    entry = dict(relic)
+    entry["available_to"] = _relic_available_to().get(name, [])
+    return {"found": True, "entry": entry}