artefacts-cli 0.8.0__tar.gz → 0.9.2__tar.gz

artefacts_cli-0.9.2/.pyre_configuration

@@ -0,0 +1,10 @@
+{
+  "site_package_search_strategy": "pep561",
+  "search_path": ["./venv/lib/python3.*/site-packages/"],
+  "source_directories": [
+    {
+      "import_root": ".",
+      "source": "artefacts"
+    }
+  ]
+}

{artefacts_cli-0.8.0 → artefacts_cli-0.9.2}/CHANGELOG.md

@@ -7,6 +7,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.9.2] - 2025-05-27
+
+### Added
+
+- Deeper and tentatively complete localisation of the CLI framework (#262)
+- ROS tests can be recorded as "error" rather than just fail or success (#267)
+
+### Fixed
+
+- Compliance with the Artefacts API protocol on reporting common scenario names
+  across parameterised runs.
+
+## [0.9.1] - 2025-04-30
+
+### Added
+
+- Runs in container accept and pass options to the underlying container engine (#246)
+- Internationalisation of command output and Japanese support (#139)
+
+### Fixed
+
+- Compliance with the Artefacts API protocol on upload/no-upload option (#217)
+
 ## [0.8.0] - 2025-04-04
 
 ### Added
@@ -76,6 +99,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Local metrics errors do not block publication of results.
 - Introduction of Black formatting. 
 
-[unreleased]: https://github.com/art-e-fact/artefacts-client/compare/0.7.0...HEAD
+[unreleased]: https://github.com/art-e-fact/artefacts-client/compare/0.9.2...HEAD
+[0.9.2]: https://github.com/art-e-fact/artefacts-client/releases/tag/0.9.2
+[0.9.1]: https://github.com/art-e-fact/artefacts-client/releases/tag/0.9.1
+[0.8.0]: https://github.com/art-e-fact/artefacts-client/releases/tag/0.8.0
 [0.7.0]: https://github.com/art-e-fact/artefacts-client/releases/tag/0.7.0
 [0.5.8]: https://github.com/art-e-fact/artefacts-client/releases/tag/0.5.8

{artefacts_cli-0.8.0 → artefacts_cli-0.9.2}/PKG-INFO

@@ -1,26 +1,28 @@
 Metadata-Version: 2.4
 Name: artefacts_cli
-Version: 0.8.0
+Version: 0.9.2
 Author-email: FD <fabian@artefacts.com>, AGC <alejandro@artefacts.com>, TN <tomo@artefacts.com>, EP <eric@artefacts.com>
+License-Expression: Apache-2.0
 Project-URL: Homepage, https://github.com/art-e-fact/artefacts-client
 Project-URL: Bug Tracker, https://github.com/art-e-fact/artefacts-client/issues
 Project-URL: Changelog, https://github.com/art-e-fact/artefacts-client/CHANGELOG.md
 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-c2d>=1.7.1
 Requires-Dist: artefacts-copava>=0.1.11
-Requires-Dist: click>=8.0.4
+Requires-Dist: artefacts-click
 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: rospkg
 Provides-Extra: dev
 Requires-Dist: awscli; extra == "dev"
+Requires-Dist: babel==2.17.0; extra == "dev"
 Requires-Dist: build; extra == "dev"
 Requires-Dist: docker; extra == "dev"
 Requires-Dist: lark; extra == "dev"
@@ -37,6 +39,7 @@ Requires-Dist: pytest-env; extra == "dev"
 Requires-Dist: pytest-mock; extra == "dev"
 Requires-Dist: python-markdown-math; extra == "dev"
 Requires-Dist: ruff>=0.9.2; extra == "dev"
+Requires-Dist: setuptools_scm>=8; extra == "dev"
 Requires-Dist: twine; extra == "dev"
 
 # Artefacts CLI
@@ -102,3 +105,7 @@ mkdocs serve -a 127.0.0.1:7000
 ```
 
 The docs are automatically deployed by the documentation workflow.
+
+## Development notes
+
+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`.

{artefacts_cli-0.8.0 → artefacts_cli-0.9.2}/README.md

@@ -61,3 +61,7 @@ mkdocs serve -a 127.0.0.1:7000
 ```
 
 The docs are automatically deployed by the documentation workflow.
+
+## Development notes
+
+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`.

{artefacts_cli-0.8.0 → artefacts_cli-0.9.2}/artefacts/cli/__init__.py

@@ -1,13 +1,15 @@
+from datetime import datetime, timezone
 from importlib.metadata import version, PackageNotFoundError
-import json
+from typing import Optional
+import copy
 import glob
-from datetime import datetime, timezone
-import os
+import json
 import math
+import os
 import requests
-import copy
-from typing import Optional
 
+from .config import APIConf
+from .i18n import localise
 from .parameters import iter_grid
 from .logger import logger
 
@@ -21,7 +23,13 @@ except PackageNotFoundError:
 
         __version__ = get_version()
     except Exception as e:
-        logger.warning(f"Could not determine package version: {e}. Default to 0.0.0")
+        logger.warning(
+            localise(
+                "Could not determine package version: {error_message}. Default to 0.0.0".format(
+                    error_message=e
+                )
+            )
+        )
         __version__ = "0.0.0"
 
 
@@ -35,7 +43,7 @@ class WarpJob:
     def __init__(
         self,
         project_id,
-        api_conf,
+        api_conf: APIConf,
         jobname,
         jobconf,
         dryrun=False,
@@ -86,7 +94,13 @@ class WarpJob:
                     msg = response.json()["message"]
                     logger.warning(msg)
                     raise AuthenticationError(msg)
-                logger.warning(f"Error on job creation: {response.status_code}")
+                logger.warning(
+                    localise(
+                        "Error on job creation: {status_code}".format(
+                            status_code=response.status_code
+                        )
+                    )
+                )
                 logger.warning(response.text)
                 raise AuthenticationError(str(response.status_code))
             self.job_id = response.json()["job_id"]
@@ -117,22 +131,25 @@ class WarpJob:
         return
 
     def new_run(self, scenario):
-        run = WarpRun(self, scenario, self.n_runs)
+        run = WarpRun(self, scenario["name"], scenario, self.n_runs)
         self.n_runs += 1
         return run
 
 
 class WarpRun:
-    def __init__(self, job, scenario, run_n):
+    def __init__(self, job: WarpJob, name: str, params: dict, run_n: int):
         self.job = job
         self.start = datetime.now(timezone.utc).timestamp()
         self.uploads = {}
-        self.params = scenario
+        self.scenario_name = name
+        self.params = params
         self.metrics = {}
         self.run_n = run_n
         self.output_path = self.params.get(
             "output_path", f"{self.job.output_path}/{self.run_n}"
         )
+        self.test_results = None
+        self.success = False
         self.logger = logger
         os.makedirs(self.output_path, exist_ok=True)
         data = {
@@ -141,6 +158,7 @@ class WarpRun:
             "start": round(self.start),
             "tests": [],
             "params": json.dumps(self.params),
+            "scenario_name": self.scenario_name,
         }
 
         if self.job.dryrun:
@@ -158,7 +176,13 @@ class WarpRun:
                 msg = response.json()["message"]
                 self.logger.warning(msg)
                 raise AuthenticationError(msg)
-            self.logger.warning(f"Error on scenario creation: {response.status_code}")
+            self.logger.warning(
+                localise(
+                    "Error on scenario creation: {status_code}".format(
+                        status_code=response.status_code
+                    )
+                )
+            )
             self.logger.warning(response.text)
             raise AuthenticationError(str(response.status_code))
         return
@@ -236,8 +260,10 @@ class WarpRun:
 
     def stop(self):
         end = datetime.now(timezone.utc).timestamp()
+
         if self.job.dryrun:
             return
+
         # Log metadata
         data = {
             "job_id": self.job.job_id,
@@ -248,18 +274,24 @@ class WarpRun:
             "duration": math.ceil(end - self.start),
             "tests": self.test_results,
             "success": self.success,
-            "uploads": self.uploads,
             "metrics": self.metrics,
+            "scenario_name": self.scenario_name,
         }
+        if not self.job.noupload:
+            data["uploads"] = self.uploads
+
         response = requests.put(
             f"{self.job.api_conf.api_url}/{self.job.project_id}/job/{self.job.job_id}/run/{self.run_n}",
             json=data,
             headers=self.job.api_conf.headers,
         )
+
         # use s3 presigned urls to upload the artifacts
         if self.job.noupload:
             print(
-                "noupload: job artifacts are not uploaded to cloud, including the ones specified in output_dirs"
+                localise(
+                    "Files generated by the job are not uploaded to Artefacts, including the ones specified in output_dirs"
+                )
             )
         else:
             upload_urls = response.json()["upload_urls"]
@@ -268,7 +300,13 @@ class WarpRun:
                 upload_info = upload_urls[key]
                 file_size_mb = os.path.getsize(file_name) / 1024 / 1024
                 try:
-                    print(f"Uploading {file_name} ({file_size_mb:.2f} MB)")
+                    print(
+                        localise(
+                            "Uploading {file_name} ({file_size:.2f} MB)".format(
+                                file_name=file_name, file_size=file_size_mb
+                            )
+                        )
+                    )
                     # TODO: add a retry policy
                     requests.post(
                         upload_info["url"],
@@ -277,15 +315,25 @@ class WarpRun:
                     )
                 except OverflowError:
                     self.logger.warning(
-                        f"File too large: {file_name} could not be uploaded"
+                        localise(
+                            "File too large: {file_name} could not be uploaded".format(
+                                file_name=file_name
+                            )
+                        )
                     )
                 except Exception as e:
-                    self.logger.warning(f"Error uploading {file_name}: {e}, skipping")
+                    self.logger.warning(
+                        localise(
+                            "Error uploading {file_name}: {error_message}, skipping".format(
+                                file_name=file_name, error_message=e
+                            )
+                        )
+                    )
 
 
 def init_job(
     project_id: str,
-    api_token: str,
+    api_conf: APIConf,
     jobname: str,
     jobconf: dict,
     dryrun: bool = False,
@@ -297,7 +345,7 @@ def init_job(
 ):
     return WarpJob(
         project_id,
-        api_token,
+        api_conf,
         jobname,
         jobconf,
         dryrun,