artefacts-cli 0.6.8__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,45 @@
1
+ <!-- top-level (meta) launch test file
2
+ provides resources as requested by the user in the artefacts.yaml file
3
+ includes the launch test file defined by the user in the artefacts.yaml file
4
+ -->
5
+ <!-- for testing (without Artefacts) use this example CLI command
6
+ rostest path_to_file ros_testpackage:=testing ros_testfile:=test_odometry.launch simulator:=none rosbag_args:=none
7
+ -->
8
+
9
+ <launch>
10
+ <!-- mandatory interfaces. CLI arguments populated by the artefacts ros1 runner based on the user's artefacts.yaml -->
11
+ <arg name="param_file" />
12
+ <arg name="ros_testpackage" />
13
+ <arg name="ros_testfile" />
14
+ <arg name="simulator" />
15
+ <arg name="rosbag_args" />
16
+
17
+ <!-- provide parameters from artefacts.yaml onto rosparam server -->
18
+ <rosparam if="$(eval not arg('param_file')=='none')"
19
+ file="$(arg param_file)"
20
+ command="load"
21
+ />
22
+
23
+ <!-- provide a simulator environment -->
24
+ <node if="$(eval arg('simulator') == 'turtlesim')"
25
+ name="turtlesim"
26
+ pkg="turtlesim"
27
+ type="turtlesim_node"
28
+ />
29
+
30
+ <!-- provide a data recorder -->
31
+ <node if="$(eval not arg('rosbag_args')=='none')"
32
+ pkg="rosbag"
33
+ type="record"
34
+ name="rosbag_recorder"
35
+ output="screen"
36
+ args="$(arg rosbag_args)"
37
+ />
38
+
39
+ <!-- include the launch test file defined by the user in artefacts.yaml -->
40
+ <include
41
+ file="$(eval find(ros_testpackage) + '/launch/' + ros_testfile)"
42
+ pass_all_args="true"
43
+ />
44
+
45
+ </launch>
@@ -0,0 +1,101 @@
1
+ Metadata-Version: 2.1
2
+ Name: artefacts_cli
3
+ Version: 0.6.8
4
+ Author-email: FD <fabian@artefacts.com>, AGC <alejandro@artefacts.com>, TN <tomo@artefacts.com>, EP <eric@artefacts.com>
5
+ Project-URL: Homepage, https://github.com/art-e-fact/artefacts-client
6
+ Project-URL: Bug Tracker, https://github.com/art-e-fact/artefacts-client/issues
7
+ Classifier: Programming Language :: Python :: 3
8
+ Classifier: License :: OSI Approved :: Apache Software License
9
+ Classifier: Operating System :: OS Independent
10
+ Requires-Python: >=3.8
11
+ Description-Content-Type: text/markdown
12
+ Requires-Dist: artefacts-copava >=0.1.11
13
+ Requires-Dist: click >=8.0.4
14
+ Requires-Dist: gitignore-parser >=0.1.11
15
+ Requires-Dist: junitparser >=2.5
16
+ Requires-Dist: mcap
17
+ Requires-Dist: mcap-ros2-support
18
+ Requires-Dist: PyYAML >=6.0
19
+ Requires-Dist: requests >=2.27.1
20
+ Provides-Extra: dev
21
+ Requires-Dist: awscli ; extra == 'dev'
22
+ Requires-Dist: build ; extra == 'dev'
23
+ Requires-Dist: lark ; extra == 'dev'
24
+ Requires-Dist: pyre-check ; extra == 'dev'
25
+ Requires-Dist: pytest ; extra == 'dev'
26
+ Requires-Dist: pytest-cov ; extra == 'dev'
27
+ Requires-Dist: pytest-env ; extra == 'dev'
28
+ Requires-Dist: pytest-mock ; extra == 'dev'
29
+ Requires-Dist: ruff ; extra == 'dev'
30
+ Requires-Dist: setuptools-scm ; extra == 'dev'
31
+ Requires-Dist: twine ; extra == 'dev'
32
+ Requires-Dist: mkdocs-click ==0.8.0 ; extra == 'dev'
33
+ Requires-Dist: mkdocs-material ==8.5.6 ; extra == 'dev'
34
+ Requires-Dist: mkdocs-mermaid2-plugin ==0.6.0 ; extra == 'dev'
35
+ Requires-Dist: mkdocs ==1.4.2 ; extra == 'dev'
36
+ Requires-Dist: pre-commit ; extra == 'dev'
37
+ Requires-Dist: python-markdown-math ; extra == 'dev'
38
+
39
+ # Artefacts CLI
40
+
41
+ CLI to the Artefacts platform.
42
+
43
+ [![Documentation](https://img.shields.io/badge/documentation-blue.svg?style=flat-square)](https://docs.artefacts.com/)
44
+ [![Code style: Black-compatible with Ruff](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
45
+
46
+ ## Requirements
47
+
48
+ * Currently working partially where Python can run.
49
+ * Fully working on ROS-compatible and ready environments. Notably need for packages like `ros-<dist>-rclpy` and `ros-<dist>-rosidl-runtime-py`.
50
+
51
+
52
+ ## Usage
53
+
54
+ To install:
55
+ ```
56
+ pip install artefacts-cli
57
+ ```
58
+
59
+ Check configuration: After creating `project-name` from the web UI and getting an API key, try:
60
+
61
+ ```
62
+ artefacts config add [project-name]
63
+ ```
64
+
65
+ and enter you `API_KEY` for the project when prompted.
66
+
67
+ You can then do
68
+
69
+ ```
70
+ artefacts hello [project-name]
71
+ ```
72
+
73
+ alternatively, you can specify you API KEY via environment variable
74
+
75
+ ```
76
+ ARTEFACTS_KEY=[your-key] artefacts hello [project-name]
77
+ ```
78
+
79
+ To run a job locally, for example the turtlesim example (need ros2 installed).
80
+ First edit `artefacts.yaml` to change the project name, then:
81
+
82
+ ```
83
+ cd examples/turtlesim
84
+ artefacts run basic_tests
85
+ ```
86
+
87
+
88
+ ## Configuration file syntax
89
+
90
+ See [the configuration syntax documentation](docs/configuration-syntax.md)
91
+
92
+
93
+ ## User docs
94
+
95
+ You can serve docs locally using mkdocs:
96
+
97
+ ```
98
+ mkdocs serve -a 127.0.0.1:7000
99
+ ```
100
+
101
+ The docs are automatically deployed by the documentation workflow.
@@ -0,0 +1,17 @@
1
+ artefacts/cli/__init__.py,sha256=9rTAfBoS9ALJxKSqaUo32ThbDshbvNN4-EmoyUsPhRI,11643
2
+ artefacts/cli/app.py,sha256=ZcSzlO-XZE8fjUHgXNcqe9Qk9GUEsdg0FWwdXE6HVG4,21178
3
+ artefacts/cli/bagparser.py,sha256=FE_QaztC9pg4hQzTjGSdyve6mzZbHJbyqa3wqvZSbxE,3702
4
+ artefacts/cli/constants.py,sha256=vZxtUprVqqZx1k4-LFFDU2tI0AnENV2cBt655uR17R8,269
5
+ artefacts/cli/other.py,sha256=7NvzlspvG0zF7sryR-QznwdLupXLln1BKWxHB9VuEcc,1160
6
+ artefacts/cli/parameters.py,sha256=MDhrM7ur95wKTLDteqz2f-sLdCPcepi5wk0XjeLo6TU,788
7
+ artefacts/cli/ros1.py,sha256=RbtirCGarD9a0ikfuGK-pdpWYSXfqJhEt4rpA0uFsyU,9625
8
+ artefacts/cli/ros2.py,sha256=g5aqOukM8ovvuIvssZ7t9F4ptOCQhHbT_DqORDyQVr4,4472
9
+ artefacts/cli/utils.py,sha256=48c8ZwuKT14R0jVMn6zoR4iVswFUR52VxXjW--693Zk,1110
10
+ artefacts/cli/utils_ros.py,sha256=pYbhAU9fK2VbnWm3nSLBwUMVBzsZuCn10SFZmVW3-Zo,2090
11
+ artefacts/cli/version.py,sha256=jFQ70HGO-FOLhIy6SpujRlrxJLVWsy5CAtewPppbaOs,411
12
+ artefacts/wrappers/artefacts_ros1_meta.launch,sha256=9tN7_0xLH8jW27KYFerhF3NuWDx2dED3ks_qoGVZAPw,1412
13
+ artefacts_cli-0.6.8.dist-info/METADATA,sha256=Nx9nS3mnBlXTupISlNfwU4lHi6a26rUsvpQDg041wyQ,3025
14
+ artefacts_cli-0.6.8.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
15
+ artefacts_cli-0.6.8.dist-info/entry_points.txt,sha256=nlTXRzilNjccbi53FgaRWCQPkG-pv61HRkaCkrKjlec,58
16
+ artefacts_cli-0.6.8.dist-info/top_level.txt,sha256=FdaMV1C9m36MWa-2Stm5xVODv7hss_nRYNwR83j_7ow,10
17
+ artefacts_cli-0.6.8.dist-info/RECORD,,
@@ -0,0 +1,5 @@
1
+ Wheel-Version: 1.0
2
+ Generator: setuptools (75.1.0)
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
5
+
@@ -0,0 +1,2 @@
1
+ [console_scripts]
2
+ artefacts = artefacts.cli.app:artefacts
@@ -0,0 +1 @@
1
+ artefacts