Skip to main content

Salpa node authoring CLI — scaffold node packages that match the shipped template contract.

Project description

salpa-cli

The Salpa node authoring CLI. Scaffolds node packages that match the shipped template contract — the deterministic path to a new node.

python3 -m pip install salpa-cli
salpa new my-analyzer          # interactive
salpa new my-suite -t multi-node-package --yes

Installing adds the salpa command. If your shell can't find salpa afterward, your Python scripts directory isn't on your PATH — installing into a virtual environment is the simplest fix (it puts salpa on PATH).

salpa new creates ./<under_scored_name>/ from a bundled template, with every placeholder substituted and the directory underscored (the dir name becomes the Python package name, so a hyphen would break from .core import ...; meta.toml's name stays kebab-case).

Templates

Templates ship inside the wheel and are the single source of truth for the node contract, so there is no second copy to drift.

Template For
individual-node one node with its own pixi env (default)
multi-node-package several related nodes sharing one pixi env, chained via predecessor_data

Options

salpa new [NAME]
  -t, --template     individual-node | multi-node-package
  -d, --description  one-line description
      --author       author name
      --category     UI category (e.g. "Cheminformatics")
  -o, --output       directory to create the package in (default: .)
  -y, --yes          non-interactive: accept defaults, no prompts
      --install      run `pixi install` in the new package afterwards

Authoring guide

salpa docs prints the bundled node-authoring guide. Full documentation: https://salpa.app/docs/custom-nodes

Reserved

salpa publish / install / run are reserved for later and not implemented in v1. v1 is salpa new (plus salpa docs).

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

salpa_cli-0.1.4-py3-none-any.whl (45.8 kB view details)

Uploaded Python 3

File details

Details for the file salpa_cli-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: salpa_cli-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 45.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for salpa_cli-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 2748e88f4c394d4b96b3b50a3992bf4e5427eee9148bdff48dc6cd916ad07f0a
MD5 a21b896b9709a6c7cd1e3e8251193e75
BLAKE2b-256 d685a25a16f45be9ae34820c0aefb4aeee1450e74a25546b58e970a67d154617

See more details on using hashes here.

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