Skip to main content

Artefacts CLI

CLI to the Artefacts platform.

Documentation Ruff Style

Status

Local Runs

Requirements

  • Currently working partially where Python can run.
  • Fully working on ROS-compatible and ready environments. Notably need for packages like ros-<dist>-rclpy and ros-<dist>-rosidl-runtime-py.

Usage

To install:

pip install artefacts-cli

Check configuration: After creating project-name from the web UI and getting an API key, try:

artefacts config add [project-name]

and enter you API_KEY for the project when prompted.

You can then do

artefacts hello [project-name]

alternatively, you can specify you API KEY via environment variable

ARTEFACTS_KEY=[your-key] artefacts hello [project-name]

To run a job locally, for example the turtlesim example (need ros2 installed). First edit artefacts.yaml to change the project name, then:

cd examples/turtlesim
artefacts run basic_tests

Configuration file syntax

See the configuration syntax documentation

User docs

You can serve docs locally using mkdocs:

mkdocs serve -a 127.0.0.1:7000

The docs are automatically deployed by the documentation workflow.

Development notes

  • After installing the dependencies, pre-commit is available to register our code checks. We suggest to register: pre-commit install
  • We use Pyre for static analysis. If it does not work out of the box, please consider adapting the .pyre_configuration file included with this repository. One assumption is that developers work in a virtual environment under ./venv.

Download files

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

Source Distribution

artefacts_cli-0.17.2.tar.gz (173.5 kB view details)

Uploaded Source

Built Distribution

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

artefacts_cli-0.17.2-py3-none-any.whl (173.2 kB view details)

Uploaded Python 3

File details

Details for the file artefacts_cli-0.17.2.tar.gz.

File metadata

  • Download URL: artefacts_cli-0.17.2.tar.gz
  • Upload date:
  • Size: 173.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for artefacts_cli-0.17.2.tar.gz
Algorithm Hash digest
SHA256 011a362f2c9223bb7a32c091212dd24c7fb71c55eba7ae5dcba11f7c862d5a89
MD5 0450620317d97b52c9c585a42d5f9e3e
BLAKE2b-256 648347102b120eaa318180367f174b89e7369a6e85662faca3cced15ac15e806

See more details on using hashes here.

File details

Details for the file artefacts_cli-0.17.2-py3-none-any.whl.

File metadata

  • Download URL: artefacts_cli-0.17.2-py3-none-any.whl
  • Upload date:
  • Size: 173.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for artefacts_cli-0.17.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2227519035d60b3b8852baa8fbecdda9e88bc80d10682fdccd709e9c84bfc1e0
MD5 fa33e0f82b63e8b3ce58939fd1f1c656
BLAKE2b-256 9ba9b043d61bca13ec117dcce328e64c5946c540544918e63c7406604dd2c78d

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.17.2 This release

2 files

0.17.1

2 files

0.17.0

2 files

0.16.2

2 files

0.16.1

2 files

0.16.0

2 files

0.15.0

2 files

0.14.0

2 files

0.13.0

2 files

0.12.0

2 files

0.11.0

2 files

0.10.2

2 files

0.10.1

2 files

0.10.0

2 files

0.9.9

1 file

0.9.8

1 file

0.9.7

1 file

0.9.6

2 files

0.9.5

2 files

0.9.3

2 files

0.9.2

2 files

0.9.1

1 file

0.8.0

2 files

0.7.3

2 files

0.7.2

2 files

0.7.1

2 files

0.7.0

2 files

0.6.19

2 files

0.6.18

2 files

0.6.17

2 files

0.6.16

2 files

0.6.15

1 file

0.6.13

2 files

0.6.12

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page