spadix-cli 0.7.2__tar.gz
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.
- spadix-cli-0.7.2/LICENSE +19 -0
- spadix-cli-0.7.2/PKG-INFO +69 -0
- spadix-cli-0.7.2/README.md +51 -0
- spadix-cli-0.7.2/pyproject.toml +6 -0
- spadix-cli-0.7.2/setup.cfg +4 -0
- spadix-cli-0.7.2/setup.py +39 -0
- spadix-cli-0.7.2/spadix_cli/__init__.py +632 -0
- spadix-cli-0.7.2/spadix_cli/__main__.py +26 -0
- spadix-cli-0.7.2/spadix_cli.egg-info/PKG-INFO +69 -0
- spadix-cli-0.7.2/spadix_cli.egg-info/SOURCES.txt +16 -0
- spadix-cli-0.7.2/spadix_cli.egg-info/dependency_links.txt +1 -0
- spadix-cli-0.7.2/spadix_cli.egg-info/entry_points.txt +2 -0
- spadix-cli-0.7.2/spadix_cli.egg-info/requires.txt +1 -0
- spadix-cli-0.7.2/spadix_cli.egg-info/top_level.txt +1 -0
- spadix-cli-0.7.2/test/test_copyright.py +20 -0
- spadix-cli-0.7.2/test/test_flake8.py +20 -0
- spadix-cli-0.7.2/test/test_pep257.py +20 -0
- spadix-cli-0.7.2/test/test_units.py +510 -0
spadix-cli-0.7.2/LICENSE
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
Copyright (c) 2021 SafeAI
|
|
2
|
+
|
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
4
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
5
|
+
in the Software without restriction, including without limitation the rights
|
|
6
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
7
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
8
|
+
furnished to do so, subject to the following conditions:
|
|
9
|
+
|
|
10
|
+
The above copyright notice and this permission notice shall be included in all
|
|
11
|
+
copies or substantial portions of the Software.
|
|
12
|
+
|
|
13
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
14
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
15
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
16
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
17
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
18
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
19
|
+
SOFTWARE.
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: spadix-cli
|
|
3
|
+
Version: 0.7.2
|
|
4
|
+
Summary: SAF friendly wrapper for colcon
|
|
5
|
+
Home-page: https://safeai.ai
|
|
6
|
+
Author: Serge Nikulin
|
|
7
|
+
Author-email: serge@safeai.ai
|
|
8
|
+
Maintainer: Serge Nikulin
|
|
9
|
+
Maintainer-email: serge@safeai.ai
|
|
10
|
+
Project-URL: Bug Tracker, https://gitlab.safeai.ai/production/spadix-cli
|
|
11
|
+
Keywords: spadix-cli
|
|
12
|
+
Classifier: Programming Language :: Python :: 3
|
|
13
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
14
|
+
Classifier: Operating System :: OS Independent
|
|
15
|
+
Requires-Python: >=3.6
|
|
16
|
+
Description-Content-Type: text/markdown
|
|
17
|
+
License-File: LICENSE
|
|
18
|
+
|
|
19
|
+
# Spadix, a friendly wrapper for `colcon`
|
|
20
|
+
|
|
21
|
+
Copyright (C) 2021 SafeAI
|
|
22
|
+
|
|
23
|
+
## Why?
|
|
24
|
+
|
|
25
|
+
Our company uses
|
|
26
|
+
[`colcon` (from collective construction build manager)](https://colcon.readthedocs.io/en/released/)
|
|
27
|
+
as our main build management tool for many years.
|
|
28
|
+
|
|
29
|
+
While we like this package, it has its problem areas, in our opinion, especially when used by
|
|
30
|
+
unexperienced engineers.
|
|
31
|
+
|
|
32
|
+
- Default build is not a merged one, and this disables Doxygen build
|
|
33
|
+
- It is allowed to run from any directory in the project tree, making the tree contaminated with
|
|
34
|
+
build artifacts
|
|
35
|
+
- By default console output is switched off and switching it back on requires an additional parameter
|
|
36
|
+
- It requires few additional parameters to run `gtest` alone
|
|
37
|
+
|
|
38
|
+
We decided to fix these deficiencies and created a wrapper `spadix` around `colcon`.
|
|
39
|
+
Catkin, ament, colcon, spadix... Got it?
|
|
40
|
+
|
|
41
|
+
## How
|
|
42
|
+
|
|
43
|
+
`spadix` accepts all `colcon` commands and options plus it adds and modifies few commands on its own.
|
|
44
|
+
|
|
45
|
+
Usage:
|
|
46
|
+
|
|
47
|
+
```sh
|
|
48
|
+
spadix [Global options] [command] [command options] ...
|
|
49
|
+
|
|
50
|
+
[Global options]
|
|
51
|
+
--no-merge : Don't use --merge-install option for colcon
|
|
52
|
+
--no-console : Don't use the default console mode: `--event-handlers console_direct+`
|
|
53
|
+
--no-root-check : Don't check that spadix being started from the root of a git project
|
|
54
|
+
|
|
55
|
+
Commands:
|
|
56
|
+
clean :Clean all projects (essentially executes `rm -rf log install build`)
|
|
57
|
+
clean:<project1>[,<project2>...] :Clean selected, comma-separated projects. Spaces not supported
|
|
58
|
+
|
|
59
|
+
build :Build all projects using --merge-install settings
|
|
60
|
+
build:<project1>[,<project2>...] Build selected, comma-separated projects. Spaces not supported
|
|
61
|
+
Build options:
|
|
62
|
+
--release : RelWithDebInfo (debug build by default)
|
|
63
|
+
--no-fif : Disable Failure Injection Framework (FIF enabled by default)
|
|
64
|
+
|
|
65
|
+
test :Test all projects using --merge-install settings
|
|
66
|
+
test:<project1>[,<project2>...] :Test selected, comma separated projects
|
|
67
|
+
|
|
68
|
+
gtest:<project> [gtest parameters] :Run gtest only ('build/test_<project name>')
|
|
69
|
+
```
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# Spadix, a friendly wrapper for `colcon`
|
|
2
|
+
|
|
3
|
+
Copyright (C) 2021 SafeAI
|
|
4
|
+
|
|
5
|
+
## Why?
|
|
6
|
+
|
|
7
|
+
Our company uses
|
|
8
|
+
[`colcon` (from collective construction build manager)](https://colcon.readthedocs.io/en/released/)
|
|
9
|
+
as our main build management tool for many years.
|
|
10
|
+
|
|
11
|
+
While we like this package, it has its problem areas, in our opinion, especially when used by
|
|
12
|
+
unexperienced engineers.
|
|
13
|
+
|
|
14
|
+
- Default build is not a merged one, and this disables Doxygen build
|
|
15
|
+
- It is allowed to run from any directory in the project tree, making the tree contaminated with
|
|
16
|
+
build artifacts
|
|
17
|
+
- By default console output is switched off and switching it back on requires an additional parameter
|
|
18
|
+
- It requires few additional parameters to run `gtest` alone
|
|
19
|
+
|
|
20
|
+
We decided to fix these deficiencies and created a wrapper `spadix` around `colcon`.
|
|
21
|
+
Catkin, ament, colcon, spadix... Got it?
|
|
22
|
+
|
|
23
|
+
## How
|
|
24
|
+
|
|
25
|
+
`spadix` accepts all `colcon` commands and options plus it adds and modifies few commands on its own.
|
|
26
|
+
|
|
27
|
+
Usage:
|
|
28
|
+
|
|
29
|
+
```sh
|
|
30
|
+
spadix [Global options] [command] [command options] ...
|
|
31
|
+
|
|
32
|
+
[Global options]
|
|
33
|
+
--no-merge : Don't use --merge-install option for colcon
|
|
34
|
+
--no-console : Don't use the default console mode: `--event-handlers console_direct+`
|
|
35
|
+
--no-root-check : Don't check that spadix being started from the root of a git project
|
|
36
|
+
|
|
37
|
+
Commands:
|
|
38
|
+
clean :Clean all projects (essentially executes `rm -rf log install build`)
|
|
39
|
+
clean:<project1>[,<project2>...] :Clean selected, comma-separated projects. Spaces not supported
|
|
40
|
+
|
|
41
|
+
build :Build all projects using --merge-install settings
|
|
42
|
+
build:<project1>[,<project2>...] Build selected, comma-separated projects. Spaces not supported
|
|
43
|
+
Build options:
|
|
44
|
+
--release : RelWithDebInfo (debug build by default)
|
|
45
|
+
--no-fif : Disable Failure Injection Framework (FIF enabled by default)
|
|
46
|
+
|
|
47
|
+
test :Test all projects using --merge-install settings
|
|
48
|
+
test:<project1>[,<project2>...] :Test selected, comma separated projects
|
|
49
|
+
|
|
50
|
+
gtest:<project> [gtest parameters] :Run gtest only ('build/test_<project name>')
|
|
51
|
+
```
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import setuptools
|
|
2
|
+
|
|
3
|
+
package_name = 'spadix-cli'
|
|
4
|
+
|
|
5
|
+
with open('README.md', 'r', encoding='utf-8') as fh:
|
|
6
|
+
long_description = fh.read()
|
|
7
|
+
|
|
8
|
+
setuptools.setup(
|
|
9
|
+
name='spadix-cli',
|
|
10
|
+
version='0.7.2',
|
|
11
|
+
packages=setuptools.find_packages(exclude=['test']),
|
|
12
|
+
install_requires=['setuptools'],
|
|
13
|
+
package_data={'': []},
|
|
14
|
+
author='Serge Nikulin',
|
|
15
|
+
author_email='serge@safeai.ai',
|
|
16
|
+
maintainer='Serge Nikulin',
|
|
17
|
+
maintainer_email='serge@safeai.ai',
|
|
18
|
+
url='https://safeai.ai',
|
|
19
|
+
project_urls={
|
|
20
|
+
'Bug Tracker': 'https://gitlab.safeai.ai/production/spadix-cli',
|
|
21
|
+
},
|
|
22
|
+
keywords=['spadix-cli'],
|
|
23
|
+
classifiers=[
|
|
24
|
+
'Programming Language :: Python :: 3',
|
|
25
|
+
'License :: OSI Approved :: MIT License',
|
|
26
|
+
'Operating System :: OS Independent',
|
|
27
|
+
],
|
|
28
|
+
description='SAF friendly wrapper for colcon',
|
|
29
|
+
long_description=long_description,
|
|
30
|
+
long_description_content_type='text/markdown',
|
|
31
|
+
python_requires='>=3.6',
|
|
32
|
+
tests_require=['pytest'],
|
|
33
|
+
test_suite='test',
|
|
34
|
+
entry_points={
|
|
35
|
+
'console_scripts': [
|
|
36
|
+
'spadix = spadix_cli.__init__:main',
|
|
37
|
+
],
|
|
38
|
+
},
|
|
39
|
+
)
|