Skip to main content

Python client library and CLI for Loobric Core (CNC tool-data sync).

Project description

loobric-cli

Python client for Loobric Core — the library and CLI for synchronizing CNC tool data. It speaks only the public REST API and depends on nothing from the server.

New in v0.4.0 — a seed script + a public sandbox. examples/quickstart.sh is a readable list of plain loobric commands that seeds an account with a small demo catalog (two manufacturers) and walks the whole loop — machine → catalog → instance → tool set → tool-table push. Run it to give a fresh account something to explore; read it to learn how to script the CLI. Point it at the free hosted sandbox and kick the tires without installing a server. See docs/SANDBOX.md.

New in v0.3.0 — full list/show symmetry. Every listable entity now has a matching show verb: show-machine, show-tool, and show-key join the existing show-* commands, each resolving its target by id, name, or unique prefix. List to find it, show to inspect it — one consistent pattern everywhere.

loobric import — stop re-typing tool data. One command auto-detects the format and turns a vendor export into catalog records on your server: DIN 4000 (CSV + XML 2013/2016), STEP P21, GTC packages (ISO 13399), SolidCAM, and hyperMILL. Every imported field keeps its source, and the raw payload is preserved verbatim so nothing is lost or guessed. GTC packages also carry the tool's 3D STEP models and images, uploaded as canonical media on servers whose media backend is enabled. See docs/IMPORTERS_PLAN.md.

The importable library (loobric.Client) and the loobric CLI are both here, ported from the old single-file loobric.py — see docs/adr/0001-extract-loobric-cli.md.

Install

pip install loobric-cli   # library + CLI + every bundled importer — stdlib only, no deps

Everything ships in the base install. The library, the loobric CLI, and all of today's importers (DIN 4000, STEP P21, GTC, SolidCAM, hyperMILL) are standard-library only, so the package stays vendorable and runs in constrained interpreters. The optional [importers] extra is reserved for future formats that need heavier parsers; no bundled importer requires it yet.

Try the sandbox

Don't want to run a server yet? Point the client at the free hosted sandbox and explore against live data:

pip install loobric-cli
export LOOBRIC_BASE_URL=https://api.loobric.com
loobric register you@example.com        # create an account
loobric login you@example.com           # then mint a key (below)
loobric create-key sandbox --scopes "read write"
export LOOBRIC_API_KEY=<the key it prints>    # the CLI reads this automatically
curl -O https://raw.githubusercontent.com/loobric/loobric-cli/master/examples/quickstart.sh
bash quickstart.sh                     # seed a demo and walk the loop

The sandbox is a shared demo server — data may be reset and accounts removed, so keep nothing real there. Full walkthrough (and why API keys, not sessions): docs/SANDBOX.md.

Library

from loobric import Client, NotFound

c = Client(base_url="http://nas:8000", api_key="...")   # solo mode: omit api_key
for s in c.list_tool_sets():
    print(s)

Every method returns parsed data and raises a LoobricClientError subclass (NotFound, AuthRequired, HTTPError, ConnectionFailed) on failure — it never prints or exits, so callers handle failure themselves.

CLI

loobric <verb> is the universal command-line client (the role the old loobric command served). See the CLI reference and walkthrough.

loobric --help
loobric list-machines
loobric show-machine mill01            # by name, id, or unique prefix
loobric create-record --from-catalog B201 --name "1/4 downcut"
loobric show-tool "1/4 downcut"        # one instance, full provenance

Every list-* verb has a matching show-* verb (show-machine, show-tool, show-tool-set, show-key, …), each resolving its target by id, name, or unique prefix — list to find it, show to inspect it.

Importing tool data

loobric import reads a vendor export, detects the format, and creates catalog records on the server. Use --dry-run to see exactly what would be created without sending anything:

loobric import tools.csv --dry-run        # DIN 4000 CSV — preview only
loobric import tools.xml                   # DIN 4000 / SolidCAM / hyperMILL (by XML root)
loobric import catalog.p21                  # STEP P21
loobric import package.zip                  # GTC package (ISO 13399) + 3D models & images

Re-importing the same catalog is detected by natural key and reported as skipped, never duplicated.

License

MIT. (The server, Loobric Core, is AGPL-3.0; this client is MIT so it can be freely vendored and reused.)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

loobric_cli-1.0.0.tar.gz (62.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

loobric_cli-1.0.0-py3-none-any.whl (55.0 kB view details)

Uploaded Python 3

File details

Details for the file loobric_cli-1.0.0.tar.gz.

File metadata

  • Download URL: loobric_cli-1.0.0.tar.gz
  • Upload date:
  • Size: 62.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for loobric_cli-1.0.0.tar.gz
Algorithm Hash digest
SHA256 a22924b265f1830d96219851e59a54c1f752929fe71300a22101e3a22cf37e40
MD5 a715fff67c2d4e7c416ddaf07002173d
BLAKE2b-256 05195f3a81fbb20bba676c4656974b2719b899515ba4952b215c5b81e4c45c2c

See more details on using hashes here.

Provenance

The following attestation bundles were made for loobric_cli-1.0.0.tar.gz:

Publisher: publish.yml on loobric/loobric-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file loobric_cli-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: loobric_cli-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 55.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for loobric_cli-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3b59097726152038e83d3adc65b81f9ed97574e2bc8b89898eff861e7a11a427
MD5 6767123e77a47fd3ecf57fecd29438e9
BLAKE2b-256 78c586d6d1a2071cc2db60de6228d01c04b17890ad088771465aa823ae5937dd

See more details on using hashes here.

Provenance

The following attestation bundles were made for loobric_cli-1.0.0-py3-none-any.whl:

Publisher: publish.yml on loobric/loobric-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page