| Name | spadix-cli JSON |
| Version |
0.7.3
JSON |
| download |
| home_page | https://safeai.ai |
| Summary | SAF friendly wrapper for colcon |
| upload_time | 2023-12-12 19:31:30 |
| maintainer | Serge Nikulin |
| docs_url | None |
| author | Serge Nikulin |
| requires_python | >=3.6 |
| license | |
| keywords |
spadix-cli
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Spadix, a friendly wrapper for `colcon`
Copyright (C) 2021 SafeAI
## Why?
Our company uses
[`colcon` (from collective construction build manager)](https://colcon.readthedocs.io/en/released/)
as our main build management tool for many years.
While we like this package, it has its problem areas, in our opinion, especially when used by
unexperienced engineers.
- Default build is not a merged one, and this disables Doxygen build
- It is allowed to run from any directory in the project tree, making the tree contaminated with
build artifacts
- By default console output is switched off and switching it back on requires an additional parameter
- It requires few additional parameters to run `gtest` alone
We decided to fix these deficiencies and created a wrapper `spadix` around `colcon`.
Catkin, ament, colcon, spadix... Got it?
## How
`spadix` accepts all `colcon` commands and options plus it adds and modifies few commands on its own.
Usage:
```sh
spadix [Global options] [command] [command options] ...
[Global options]
--no-merge : Don't use --merge-install option for colcon
--no-console : Don't use the default console mode: `--event-handlers console_direct+`
--no-root-check : Don't check that spadix being started from the root of a git project
Commands:
clean :Clean all projects (essentially executes `rm -rf log install build`)
clean:<project1>[,<project2>...] :Clean selected, comma-separated projects. Spaces not supported
build :Build all projects using --merge-install settings
build:<project1>[,<project2>...] Build selected, comma-separated projects. Spaces not supported
Build options:
--release : RelWithDebInfo (debug build by default)
--no-fif : Disable Failure Injection Framework (FIF enabled by default)
test :Test all projects using --merge-install settings
test:<project1>[,<project2>...] :Test selected, comma separated projects
gtest:<project> [gtest parameters] :Run gtest only ('build/test_<project name>')
```
Raw data
{
"_id": null,
"home_page": "https://safeai.ai",
"name": "spadix-cli",
"maintainer": "Serge Nikulin",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "serge@safeai.ai",
"keywords": "spadix-cli",
"author": "Serge Nikulin",
"author_email": "serge@safeai.ai",
"download_url": "https://files.pythonhosted.org/packages/df/10/21f0b34081c2a52805da975f619f1bd2fe78dd9e59098180cb80881c8b81/spadix-cli-0.7.3.tar.gz",
"platform": null,
"description": "# Spadix, a friendly wrapper for `colcon`\r\n\r\nCopyright (C) 2021 SafeAI\r\n\r\n## Why?\r\n\r\nOur company uses\r\n[`colcon` (from collective construction build manager)](https://colcon.readthedocs.io/en/released/)\r\nas our main build management tool for many years.\r\n\r\nWhile we like this package, it has its problem areas, in our opinion, especially when used by\r\nunexperienced engineers.\r\n\r\n- Default build is not a merged one, and this disables Doxygen build\r\n- It is allowed to run from any directory in the project tree, making the tree contaminated with\r\nbuild artifacts\r\n- By default console output is switched off and switching it back on requires an additional parameter\r\n- It requires few additional parameters to run `gtest` alone\r\n\r\nWe decided to fix these deficiencies and created a wrapper `spadix` around `colcon`.\r\nCatkin, ament, colcon, spadix... Got it?\r\n\r\n## How\r\n\r\n`spadix` accepts all `colcon` commands and options plus it adds and modifies few commands on its own.\r\n\r\nUsage:\r\n\r\n```sh\r\nspadix [Global options] [command] [command options] ...\r\n\r\n[Global options]\r\n--no-merge : Don't use --merge-install option for colcon\r\n--no-console : Don't use the default console mode: `--event-handlers console_direct+`\r\n--no-root-check : Don't check that spadix being started from the root of a git project\r\n\r\nCommands:\r\nclean :Clean all projects (essentially executes `rm -rf log install build`)\r\nclean:<project1>[,<project2>...] :Clean selected, comma-separated projects. Spaces not supported\r\n\r\nbuild :Build all projects using --merge-install settings\r\nbuild:<project1>[,<project2>...] Build selected, comma-separated projects. Spaces not supported\r\n Build options:\r\n --release : RelWithDebInfo (debug build by default)\r\n --no-fif : Disable Failure Injection Framework (FIF enabled by default)\r\n\r\ntest :Test all projects using --merge-install settings\r\ntest:<project1>[,<project2>...] :Test selected, comma separated projects\r\n\r\ngtest:<project> [gtest parameters] :Run gtest only ('build/test_<project name>')\r\n```\r\n",
"bugtrack_url": null,
"license": "",
"summary": "SAF friendly wrapper for colcon",
"version": "0.7.3",
"project_urls": {
"Bug Tracker": "https://gitlab.safeai.ai/production/spadix-cli",
"Homepage": "https://safeai.ai"
},
"split_keywords": [
"spadix-cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "da206aa8b075deeebca27f28651d88c583963494a901b1588c62ddc51669c6e3",
"md5": "6137a06e93ac74df451fb9a684ff71a5",
"sha256": "1e0b5ae2e5ff95e72f259823c6eb4afbf9b38b1caeb4b6e90a61449f3ff841b2"
},
"downloads": -1,
"filename": "spadix_cli-0.7.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6137a06e93ac74df451fb9a684ff71a5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 8825,
"upload_time": "2023-12-12T19:31:28",
"upload_time_iso_8601": "2023-12-12T19:31:28.848274Z",
"url": "https://files.pythonhosted.org/packages/da/20/6aa8b075deeebca27f28651d88c583963494a901b1588c62ddc51669c6e3/spadix_cli-0.7.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "df1021f0b34081c2a52805da975f619f1bd2fe78dd9e59098180cb80881c8b81",
"md5": "580e5c497c7801d6213f66062443eb55",
"sha256": "a664ef0ffce89914a55304de00d30bbe13d37e9c6ab79d45c9224930d9f9dbd5"
},
"downloads": -1,
"filename": "spadix-cli-0.7.3.tar.gz",
"has_sig": false,
"md5_digest": "580e5c497c7801d6213f66062443eb55",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 10901,
"upload_time": "2023-12-12T19:31:30",
"upload_time_iso_8601": "2023-12-12T19:31:30.970494Z",
"url": "https://files.pythonhosted.org/packages/df/10/21f0b34081c2a52805da975f619f1bd2fe78dd9e59098180cb80881c8b81/spadix-cli-0.7.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-12 19:31:30",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "spadix-cli"
}
