lr-gladiator 0.3.0__tar.gz → 0.13.0__tar.gz

lr_gladiator-0.13.0/PKG-INFO

@@ -0,0 +1,198 @@
+Metadata-Version: 2.4
+Name: lr-gladiator
+Version: 0.13.0
+Summary: CLI and Python client for Arena PLM (app.bom.com): login, get revisions, list/download attachments, and upload to working revisions.
+Author-email: Jonas Estberger <jonas.estberger@lumenradio.com>
+License: MIT
+Keywords: Arena,PLM,BOM,attachments,CLI
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.32
+Requires-Dist: typer>=0.12
+Requires-Dist: rich>=13.7
+Requires-Dist: pydantic>=2.8
+Provides-Extra: dev
+Requires-Dist: build>=1.2.1; extra == "dev"
+Requires-Dist: twine>=5.1.1; extra == "dev"
+Requires-Dist: wheel; extra == "dev"
+Requires-Dist: pytest>=8.4.2; extra == "dev"
+Requires-Dist: black>=25.9.0; extra == "dev"
+Requires-Dist: pytest-html; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Dynamic: license-file
+
+# gladiator-arena
+
+CLI + Python client for interacting with the Arena PLM.
+
+## Install
+
+```bash
+pip install lr-gladiator
+```
+
+## Quick start
+
+### Login
+
+Interactive login (prompts for username/password):
+
+```bash
+gladiator login
+```
+
+Non-interactive (for CI/CD):
+
+```bash
+export GLADIATOR_USERNAME="<insert username>"
+export GLADIATOR_PASSWORD="<insert password>"
+gladiator login --ci
+```
+
+By default, this stores session details at:
+
+```
+~/.config/gladiator/login.json
+```
+
+### Commands
+
+Get the latest approved revision for an item:
+
+```bash
+gladiator latest-approved 890-1001
+```
+
+List all files on an item (defaults to the latest approved revision):
+
+```bash
+gladiator list-files 890-1001
+```
+
+Output JSON instead of a table:
+
+```bash
+gladiator list-files 890-1001 --format json
+```
+
+List the Bill of Materials (BOM) for an item:
+
+```bash
+gladiator bom 890-1001
+```
+
+Recursively expand subassemblies up to two levels deep:
+
+```bash
+gladiator bom 890-1001 --recursive --max-depth 2
+```
+
+Download attached files to a directory named after the article:
+
+```bash
+gladiator get-files 890-1001
+```
+
+Specify a different output directory:
+
+```bash
+gladiator get-files 890-1001 --out downloads/
+```
+
+Recursively download all files in the full BOM tree:
+
+```bash
+gladiator get-files 890-1001 --recursive
+```
+
+Upload or update a file on the working revision:
+
+```bash
+gladiator upload-file 890-1001 ./datasheet.pdf --category "CAD Data" --title "Datasheet"
+```
+
+### 3) Output control
+
+Most commands support a JSON output mode.  
+Example:
+
+```bash
+gladiator bom 890-1001 --output json
+```
+
+### Example sessions
+
+#### Human-readable
+
+```bash
+$ gladiator list-files 101-1031
+         Files for 101-1031 rev (latest approved)         
+┏━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┳━━━━━━┳━━━━━━━━━━┓
+┃ Name            ┃     Size ┃ Edition ┃ Type ┃ Location ┃
+┡━━━━━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━╇━━━━━━╇━━━━━━━━━━┩
+│ 101-1907 E.PDF  │   171396 │ 1       │ FILE │          │
+└─────────────────┴──────────┴─────────┴──────┴──────────┘
+```
+
+#### JSON output
+
+```bash
+$ gladiator list-files 101-1031 --format json
+{
+  "article": "101-1031",
+  "revision": null,
+  "files": [
+    {
+      "id": "00000000000000000000",
+      "fileGuid": "11111111111111111111",
+      "name": "101-1907 E.PDF",
+      "filename": "101-1907 E.PDF",
+      "size": 171396,
+      "haveContent": true,
+      "downloadUrl": "https://api.arenasolutions.com/v1/files/11111111111111111111/content",
+      "edition": "1",
+      "updatedAt": "2016-12-06T12:31:33Z",
+      "attachmentGroupGuid": "22222222222222222222",
+      "storageMethodName": "FILE",
+      "location": null
+    }
+  ]
+}
+```
+
+## Programmatic use
+
+```python
+from gladiator import ArenaClient, load_config
+
+client = ArenaClient(load_config())
+rev = client.get_latest_approved_revision("890-1001")
+files = client.list_files("890-1001", rev)
+```
+
+## Development
+
+```bash
+python -m pip install -e .[dev]
+python -m build
+```
+
+## FAQ
+
+- **Where is the config kept?**
+  `~/.config/gladiator/login.json` (override with `GLADIATOR_CONFIG`)
+
+- **How do I run non-interactively?**
+  Make sure to give all required arguments. Also pass `--ci` to stop output of sensitive information such as username or passwords.
+
+- **What does `--recursive` do?**
+  Expands subassemblies and downloads or lists all contained items up to the given `--max-depth`.
+
+- **How does Gladiator handle authentication?**
+  It performs a `/login` call and stores the resulting `arenaSessionId` for reuse. If it expires, re-run `gladiator login`.
+
+

lr_gladiator-0.13.0/README.md

@@ -0,0 +1,171 @@
+# gladiator-arena
+
+CLI + Python client for interacting with the Arena PLM.
+
+## Install
+
+```bash
+pip install lr-gladiator
+```
+
+## Quick start
+
+### Login
+
+Interactive login (prompts for username/password):
+
+```bash
+gladiator login
+```
+
+Non-interactive (for CI/CD):
+
+```bash
+export GLADIATOR_USERNAME="<insert username>"
+export GLADIATOR_PASSWORD="<insert password>"
+gladiator login --ci
+```
+
+By default, this stores session details at:
+
+```
+~/.config/gladiator/login.json
+```
+
+### Commands
+
+Get the latest approved revision for an item:
+
+```bash
+gladiator latest-approved 890-1001
+```
+
+List all files on an item (defaults to the latest approved revision):
+
+```bash
+gladiator list-files 890-1001
+```
+
+Output JSON instead of a table:
+
+```bash
+gladiator list-files 890-1001 --format json
+```
+
+List the Bill of Materials (BOM) for an item:
+
+```bash
+gladiator bom 890-1001
+```
+
+Recursively expand subassemblies up to two levels deep:
+
+```bash
+gladiator bom 890-1001 --recursive --max-depth 2
+```
+
+Download attached files to a directory named after the article:
+
+```bash
+gladiator get-files 890-1001
+```
+
+Specify a different output directory:
+
+```bash
+gladiator get-files 890-1001 --out downloads/
+```
+
+Recursively download all files in the full BOM tree:
+
+```bash
+gladiator get-files 890-1001 --recursive
+```
+
+Upload or update a file on the working revision:
+
+```bash
+gladiator upload-file 890-1001 ./datasheet.pdf --category "CAD Data" --title "Datasheet"
+```
+
+### 3) Output control
+
+Most commands support a JSON output mode.  
+Example:
+
+```bash
+gladiator bom 890-1001 --output json
+```
+
+### Example sessions
+
+#### Human-readable
+
+```bash
+$ gladiator list-files 101-1031
+         Files for 101-1031 rev (latest approved)         
+┏━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┳━━━━━━┳━━━━━━━━━━┓
+┃ Name            ┃     Size ┃ Edition ┃ Type ┃ Location ┃
+┡━━━━━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━╇━━━━━━╇━━━━━━━━━━┩
+│ 101-1907 E.PDF  │   171396 │ 1       │ FILE │          │
+└─────────────────┴──────────┴─────────┴──────┴──────────┘
+```
+
+#### JSON output
+
+```bash
+$ gladiator list-files 101-1031 --format json
+{
+  "article": "101-1031",
+  "revision": null,
+  "files": [
+    {
+      "id": "00000000000000000000",
+      "fileGuid": "11111111111111111111",
+      "name": "101-1907 E.PDF",
+      "filename": "101-1907 E.PDF",
+      "size": 171396,
+      "haveContent": true,
+      "downloadUrl": "https://api.arenasolutions.com/v1/files/11111111111111111111/content",
+      "edition": "1",
+      "updatedAt": "2016-12-06T12:31:33Z",
+      "attachmentGroupGuid": "22222222222222222222",
+      "storageMethodName": "FILE",
+      "location": null
+    }
+  ]
+}
+```
+
+## Programmatic use
+
+```python
+from gladiator import ArenaClient, load_config
+
+client = ArenaClient(load_config())
+rev = client.get_latest_approved_revision("890-1001")
+files = client.list_files("890-1001", rev)
+```
+
+## Development
+
+```bash
+python -m pip install -e .[dev]
+python -m build
+```
+
+## FAQ
+
+- **Where is the config kept?**
+  `~/.config/gladiator/login.json` (override with `GLADIATOR_CONFIG`)
+
+- **How do I run non-interactively?**
+  Make sure to give all required arguments. Also pass `--ci` to stop output of sensitive information such as username or passwords.
+
+- **What does `--recursive` do?**
+  Expands subassemblies and downloads or lists all contained items up to the given `--max-depth`.
+
+- **How does Gladiator handle authentication?**
+  It performs a `/login` call and stores the resulting `arenaSessionId` for reuse. If it expires, re-run `gladiator login`.
+
+

{lr_gladiator-0.3.0 → lr_gladiator-0.13.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "lr-gladiator"
-version = "0.3.0"
+version = "0.13.0"
 description = "CLI and Python client for Arena PLM (app.bom.com): login, get revisions, list/download attachments, and upload to working revisions."
 readme = "README.md"
 requires-python = ">=3.9"
@@ -32,4 +32,4 @@ package-dir = {"" = "src"}
 packages = ["gladiator"]
 
 [project.optional-dependencies]
-dev = ["build>=1.2.1", "twine>=5.1.1", "wheel"]
+dev = ["build>=1.2.1", "twine>=5.1.1", "wheel", "pytest>=8.4.2", "black>=25.9.0", "pytest-html", "pytest-cov"]

{lr_gladiator-0.3.0 → lr_gladiator-0.13.0}/src/gladiator/__init__.py

@@ -4,4 +4,4 @@
 
 __all__ = ["ArenaClient", "load_config", "save_config"]
 from .arena import ArenaClient
-from .config import load_config, save_config
+from .config import load_config, save_config