lr-gladiator 0.12.0__py3-none-any.whl

lr_gladiator-0.12.0.dist-info/METADATA

@@ -0,0 +1,198 @@
+Metadata-Version: 2.4
+Name: lr-gladiator
+Version: 0.12.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.12.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+gladiator/__init__.py,sha256=ZeHpVdzARFyIp9QbdTkX0jNqnbRFX5nFQ5RkEFzSRL0,208
+gladiator/arena.py,sha256=LphoXXJh1QXB5A_67S-qGA2GQs2lPhbNbZUjTiodDkY,42808
+gladiator/checksums.py,sha256=5_3ra5E6itOPhWkb9MAR1ywuMtnVa_CxdcAe8t5x3PM,934
+gladiator/cli.py,sha256=o0GfY2APUoZVKIS6Z-uSMweFnwuejt9sIk4xO1CKlsI,14773
+gladiator/config.py,sha256=jlSIeAXrYdcbgHiz5gX_DEYeUBxr87NMIbEMcdChYVI,1941
+lr_gladiator-0.12.0.dist-info/licenses/LICENSE,sha256=2CEtbEagerjoU3EDSk-eTM5LKgI_RpiVIOh3_CV4kms,1069
+lr_gladiator-0.12.0.dist-info/METADATA,sha256=a0PwsIatqneDZdbff3CvfwjlxVuHxLn1DZU7HmD3bJY,4899
+lr_gladiator-0.12.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+lr_gladiator-0.12.0.dist-info/entry_points.txt,sha256=SLka4w7iGS2B8HrbeZyNk5mxaIC6QKcv93us1OaWNwQ,48
+lr_gladiator-0.12.0.dist-info/top_level.txt,sha256=tfrcAmK7_7Lf63w7kWy0wv_Qg9RrcFWGoins1-jGUF4,10
+lr_gladiator-0.12.0.dist-info/RECORD,,

lr_gladiator-0.12.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

lr_gladiator-0.12.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+gladiator = gladiator.cli:app

lr_gladiator-0.12.0.dist-info/licenses/LICENSE

@@ -0,0 +1,25 @@
+MIT License
+
+
+Copyright (c) 2025 Your Name
+
+
+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
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+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.

lr_gladiator-0.12.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+gladiator