Metadata-Version: 2.1
Name: artefacts_cli
Version: 0.6.15
Author-email: FD <fabian@artefacts.com>, AGC <alejandro@artefacts.com>, TN <tomo@artefacts.com>, EP <eric@artefacts.com>
Project-URL: Homepage, https://github.com/art-e-fact/artefacts-client
Project-URL: Bug Tracker, https://github.com/art-e-fact/artefacts-client/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: artefacts-copava >=0.1.11
Requires-Dist: click >=8.0.4
Requires-Dist: gitignore-parser >=0.1.11
Requires-Dist: junitparser >=2.5
Requires-Dist: mcap
Requires-Dist: mcap-ros2-support
Requires-Dist: PyYAML >=6.0
Requires-Dist: requests >=2.27.1
Requires-Dist: setuptools-scm
Provides-Extra: dev
Requires-Dist: awscli ; extra == 'dev'
Requires-Dist: build ; extra == 'dev'
Requires-Dist: docker ; extra == 'dev'
Requires-Dist: lark ; extra == 'dev'
Requires-Dist: pyre-check ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: pytest-env ; extra == 'dev'
Requires-Dist: pytest-mock ; extra == 'dev'
Requires-Dist: ruff ; extra == 'dev'
Requires-Dist: twine ; extra == 'dev'
Requires-Dist: mkdocs-click ==0.8.0 ; extra == 'dev'
Requires-Dist: mkdocs-material ==8.5.6 ; extra == 'dev'
Requires-Dist: mkdocs-mermaid2-plugin ==0.6.0 ; extra == 'dev'
Requires-Dist: mkdocs ==1.4.2 ; extra == 'dev'
Requires-Dist: pre-commit ; extra == 'dev'
Requires-Dist: python-markdown-math ; extra == 'dev'

# Artefacts CLI

CLI to the Artefacts platform.

[![Documentation](https://img.shields.io/badge/documentation-blue.svg?style=flat-square)](https://docs.artefacts.com/)
[![Code style: Black-compatible with Ruff](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

## 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](docs/configuration-syntax.md)


## 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.
