Skip to main content

Experimental CLI for deploying robotic applications

Project description

arm-cli

PyPI Changelog Tests License

Experimental CLI for deploying robotic applications

Installation

Install this tool using pip:

pip install arm-cli

Once installed, setup the CLI initially by running arm-cli system setup. You may need to rerun if you update the CLI via pip. This will do things like configure system settings to enable tab complete.

Note: If you installed the CLI with pip install --user, you may need to manually run the local bin version the first time:

~/.local/bin/arm-cli system setup

Usage

Initial Setup

For help, run:

arm-cli --help

You can also use:

python -m arm_cli --help

Container Management

The CLI includes tools for managing Docker containers:

# List running containers
arm-cli container list

# Attach to a container interactively (sources ROS and interactive entrypoints)
arm-cli container attach

# Restart a container
arm-cli container restart

# Stop a container
arm-cli container stop

For more details on container compliance, see arm_cli/container/readme.md.

Development

To contribute to this tool, first checkout the code. Then create a new virtual environment. From the root of the repo:

cd arm-cli
python -m venv venv
source venv/bin/activate

Now install the dependencies and test dependencies:

pip install -e '.[dev]'

To run the tests:

python -m pytest

Troubleshooting

  • If editable install fails, ensure you have a modern toolchain:
    python -m pip install --upgrade pip setuptools wheel build setuptools-scm
    
  • If the reported version is 0+unknown, ensure you're working from a Git checkout with tags available:
    git fetch --tags --force
    

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

arm_cli-0.1.10.tar.gz (35.3 kB view details)

Uploaded Source

Built Distribution

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

arm_cli-0.1.10-py3-none-any.whl (33.0 kB view details)

Uploaded Python 3

File details

Details for the file arm_cli-0.1.10.tar.gz.

File metadata

  • Download URL: arm_cli-0.1.10.tar.gz
  • Upload date:
  • Size: 35.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for arm_cli-0.1.10.tar.gz
Algorithm Hash digest
SHA256 0d288565b57eed7a7cd54fb99e5b6c5a537e1683174653a0543b5cee246c1cdf
MD5 29b0b20bca44c6d1ae286998d9501a7e
BLAKE2b-256 b30dd147aad9cd8317c8d14f4c346585539157cadc98b8d28177c7dc54fff5ab

See more details on using hashes here.

Provenance

The following attestation bundles were made for arm_cli-0.1.10.tar.gz:

Publisher: publish.yml on mpowelson/arm-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 arm_cli-0.1.10-py3-none-any.whl.

File metadata

  • Download URL: arm_cli-0.1.10-py3-none-any.whl
  • Upload date:
  • Size: 33.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for arm_cli-0.1.10-py3-none-any.whl
Algorithm Hash digest
SHA256 263ec77382aeae4e899580a0b7110d9f6af526b835d674415e562462e36e06d5
MD5 f4ee955fb375532dd231bf01d78f934e
BLAKE2b-256 d0f3b25eb2f826e68957e44ed27ed83c5d8a22f3f41a8d7f832523e2f7d5105c

See more details on using hashes here.

Provenance

The following attestation bundles were made for arm_cli-0.1.10-py3-none-any.whl:

Publisher: publish.yml on mpowelson/arm-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