A wrapper package designed for running continuous integration (CI) build steps using Python 3.6+.
Managing cross platform build scripts for CI can become tedious at times when you need
to e.g., maintain two nearly identical scripts
install_deps.bat due to incompatible syntaxes.
ci_exec enables a single file
to manage this using Python.
ci_exec package provides a set of wrappers / utility functions designed
specifically for running build steps on CI providers. It is
- Logging by Default
- Commands executed, including their full command-line arguments, are logged. This
includes any output on
stderrfrom the commands. The logging resembles what
set -xwould give you in a shell script. For commands that will take a long time, as long as output is being produced, this will additionally prevent timeouts on the build.
- Failing by Default
- Any command that does not succeed will fail the entire build. An attempt to exit with the same exit code as the command that failed will be performed. Meaning the CI provider will correctly report a failed build.
ci_execaffords users the ability to write shell-like scripts that will work on any platform that Python can run on. A simple example:
from ci_exec import cd, which cmake = which("cmake") ninja = which("ninja") with cd("build", create=True): cmake("..", "-G", "Ninja", "-DCMAKE_BUILD_TYPE=Release") ninja("-j", "2", "test")
ci_exec is available on PyPI. It can be
installed using your python package manager of choice:
$ pip install ci-exec
The PyPI package has a
There is also a
setup.py here, so you can also install it from source:
$ pip install git+https://github.com/svenevs/ci_exec.git@master
This software is licensed under the Apache 2.0 license.