Metadata-Version: 2.4
Name: forge-lens
Version: 0.1.0
Summary: DataForge Query — library for loading, querying, and traversing Star Citizen DataForge XML
Project-URL: Homepage, https://github.com/jonigirl/forge-lens
Project-URL: Repository, https://github.com/jonigirl/forge-lens
Project-URL: Bug Tracker, https://github.com/jonigirl/forge-lens/issues
Author: Joni Hayes
License-Expression: MIT
License-File: LICENSE
Keywords: dataforge,game data,query,star citizen,xml
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Games/Entertainment
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.12
Provides-Extra: dev
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: ruff>=0.4; extra == 'dev'
Description-Content-Type: text/markdown

# forge-lens — DataForge Query

[![PyPI](https://img.shields.io/pypi/v/forge-lens)](https://pypi.org/project/forge-lens/)
[![GitHub](https://img.shields.io/badge/github-jonigirl%2Fforge--lens-blue)](https://github.com/jonigirl/forge-lens)

Python library for loading, querying, and traversing Star Citizen DataForge XML records extracted by [unp4k/unforge](https://github.com/dolkensp/unp4k).

---

## Install

```
pip install forge-lens
```

---

## Quickstart

```python
from forge_lens import DataForgeLoader, Query, Graph

# Load all extracted DataForge XML files
loader = DataForgeLoader(r"C:\SCData\Data\Libs\Foundry\Records")
loader.load()

# Query records by type and attribute
results = (
    Query(loader)
    .of_type("SItemCooler")
    .where("__name", "COOLER_S01_INDUSTRIAL_FLEXI")
    .all()
)

for elem in results:
    print(elem.attrib)

# Build UUID graph for relationship traversal
graph = Graph(loader)
graph.build()

# Resolve a UUID to a display name
name = graph.resolve_name("some-uuid-here")
```

---

## Legal Notice

Star Citizen and all associated game data are the property of Cloud Imperium Rights LLC. forge-lens only reads files from your own licensed installation and does not redistribute any RSI or CIG content. This is an unofficial fan tool, not affiliated with or endorsed by Cloud Imperium Games.

---

## Links

- [PyPI — dfq](https://pypi.org/project/dfq/)
- [GitHub — forge-lens](https://github.com/jonigirl/forge-lens)
- [Bug Tracker](https://github.com/jonigirl/forge-lens/issues)
