Jolt
============================
.. image:: https://img.shields.io/pypi/v/jolt.svg
:target: https://pypi.python.org/pypi/jolt/
.. image:: https://readthedocs.org/projects/jolt/badge/?version=latest
:target: http://jolt.readthedocs.io/?badge=latest
Jolt is a task execution tool designed for software development tasks.
It can build your C/C++ applications and React frontends, run tests, deploy your web services,
and much more.
Tasks are defined in Python scripts. They may be executed locally by developers or by automation software
such as Jenkins in a continuous integration pipeline. In both cases, tasks may be distributed and executed
in parallel in a server cluster. The output of each task is cached to reduce overall execution times on
repeat attempts. In one real world deployment, Jolt shortend the CI build duration from 10 hours to 10 minutes
on average.
Example C++ application task:
.. code:: python
class CppApp(CXXExecutable):
""" Builds a C++ application """
arch = Parameter(values=["arm", "x64"])
requires = [
"git:url=https://github.com/org/cppapp.git",
"gcc:arch={arch},version=9.1.1",
]
sources = ["cppapp/include/*.hpp", "cppapp/src/*.cpp"]
.. code:: bash
$ jolt build cppapp:arch=x64
Example Node.js tasks:
.. code:: python
class NodeJS(Download):
""" Downloads and publishes Node.js. Adds binaries to PATH. """
version = Parameter("14.16.1")
url = "https://nodejs.org/dist/v{version}/node-v{version}-win-x64.zip"
def publish(self, artifact, tools):
super(publish).publish(artifact, tools)
artifact.environ.PATH.append("node-v{version}-win-x64")
class WebApp(Task):
""" Builds a really cool WebApp """
requires = [
"git:url=https://github.com/org/webapp.git",
"nodejs"
]
def run(self, deps, tools):
with tools.cwd("webapp"):
tools.run("npm ci")
tools.run("npm build")
.. code:: bash
$ jolt build webapp
A common command line interface for all tasks enables developers from different
disciplines to quickly run each others tasks without in-depth knowledge of the underlying technology -
a C++ developer doesn't have to learn NPM and a React developer doesn't have to know anything about
CMake, Make, MSBuild, etc. Required tools and dependencies are also provisioned automatically.
For full documentation, please visit http://jolt.readthedocs.io/
Installing
----------
Jolt is available in the Python Package Index:
.. code:: bash
$ pip install jolt
$ jolt
And as a Docker image:
.. code:: bash
$ docker run robrt/jolt
A thin Python wrapper is available for the Docker images. By using it, multiple versions
of Jolt can coexist on the host since the version used is selected during runtime rather
than install time. To use a specific version in a project, add a version attribute in the
Jolt manifest. By always using a specific version cache hits become more likely.
.. code:: bash
$ pip install jolt_docker
$ jolt
Raw data
{
"_id": null,
"home_page": "https://github.com/srand/jolt",
"name": "jolt",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "bazel, build, cmake, conan, jolt, make, meson, msbuild, xcode",
"author": "Robert Andersson",
"author_email": "srand@github.com",
"download_url": "https://files.pythonhosted.org/packages/5e/8e/f8075faa8bf72e0e9afe232ee0c4827a6ddf472151e57386e8b53337d484/jolt-0.9.221.tar.gz",
"platform": null,
"description": "Jolt\n============================\n\n.. image:: https://img.shields.io/pypi/v/jolt.svg\n :target: https://pypi.python.org/pypi/jolt/\n \n.. image:: https://readthedocs.org/projects/jolt/badge/?version=latest\n :target: http://jolt.readthedocs.io/?badge=latest\n\n\nJolt is a task execution tool designed for software development tasks.\nIt can build your C/C++ applications and React frontends, run tests, deploy your web services, \nand much more.\n\nTasks are defined in Python scripts. They may be executed locally by developers or by automation software \nsuch as Jenkins in a continuous integration pipeline. In both cases, tasks may be distributed and executed \nin parallel in a server cluster. The output of each task is cached to reduce overall execution times on \nrepeat attempts. In one real world deployment, Jolt shortend the CI build duration from 10 hours to 10 minutes\non average.\n \nExample C++ application task:\n \n.. code:: python\n \n class CppApp(CXXExecutable):\n \"\"\" Builds a C++ application \"\"\"\n arch = Parameter(values=[\"arm\", \"x64\"])\n requires = [\n \"git:url=https://github.com/org/cppapp.git\",\n \"gcc:arch={arch},version=9.1.1\",\n ]\n sources = [\"cppapp/include/*.hpp\", \"cppapp/src/*.cpp\"]\n\n.. code:: bash\n \n $ jolt build cppapp:arch=x64\n\n\nExample Node.js tasks:\n \n.. code:: python\n \n class NodeJS(Download):\n \"\"\" Downloads and publishes Node.js. Adds binaries to PATH. \"\"\"\n\n version = Parameter(\"14.16.1\")\n url = \"https://nodejs.org/dist/v{version}/node-v{version}-win-x64.zip\"\n\n def publish(self, artifact, tools):\n super(publish).publish(artifact, tools)\n artifact.environ.PATH.append(\"node-v{version}-win-x64\")\n\n\n class WebApp(Task):\n \"\"\" Builds a really cool WebApp \"\"\"\n \n requires = [\n \"git:url=https://github.com/org/webapp.git\",\n \"nodejs\"\n ]\n \n def run(self, deps, tools):\n with tools.cwd(\"webapp\"):\n tools.run(\"npm ci\")\n tools.run(\"npm build\")\n \n.. code:: bash\n \n $ jolt build webapp\n\nA common command line interface for all tasks enables developers from different \ndisciplines to quickly run each others tasks without in-depth knowledge of the underlying technology - \na C++ developer doesn't have to learn NPM and a React developer doesn't have to know anything about \nCMake, Make, MSBuild, etc. Required tools and dependencies are also provisioned automatically.\n\nFor full documentation, please visit http://jolt.readthedocs.io/\n\n\nInstalling\n----------\n\nJolt is available in the Python Package Index:\n\n.. code:: bash\n\n $ pip install jolt\n $ jolt\n\nAnd as a Docker image:\n\n.. code:: bash\n\n $ docker run robrt/jolt\n\nA thin Python wrapper is available for the Docker images. By using it, multiple versions\nof Jolt can coexist on the host since the version used is selected during runtime rather\nthan install time. To use a specific version in a project, add a version attribute in the\nJolt manifest. By always using a specific version cache hits become more likely.\n\n.. code:: bash\n\n $ pip install jolt_docker\n $ jolt\n",
"bugtrack_url": null,
"license": null,
"summary": "A task executor",
"version": "0.9.221",
"project_urls": {
"Homepage": "https://github.com/srand/jolt"
},
"split_keywords": [
"bazel",
" build",
" cmake",
" conan",
" jolt",
" make",
" meson",
" msbuild",
" xcode"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5ee336fc5a4944a15b3414506570e8dfa21375ef1a5a42dbd45673bc3b697851",
"md5": "ac064ab881e2be94cd7a21b9b4ef5031",
"sha256": "da1e1980f86c7689cf4580c3d605fbd36439ec3461188636f5cc86a9990946e8"
},
"downloads": -1,
"filename": "jolt-0.9.221-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ac064ab881e2be94cd7a21b9b4ef5031",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6372865,
"upload_time": "2024-05-17T17:54:41",
"upload_time_iso_8601": "2024-05-17T17:54:41.198049Z",
"url": "https://files.pythonhosted.org/packages/5e/e3/36fc5a4944a15b3414506570e8dfa21375ef1a5a42dbd45673bc3b697851/jolt-0.9.221-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5e8ef8075faa8bf72e0e9afe232ee0c4827a6ddf472151e57386e8b53337d484",
"md5": "7454448ad571bb3f515323102351ee6d",
"sha256": "08b741532cedb58079ca53cc7fccbbcd894b2fd925032048ccb52de296350af9"
},
"downloads": -1,
"filename": "jolt-0.9.221.tar.gz",
"has_sig": false,
"md5_digest": "7454448ad571bb3f515323102351ee6d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 6280672,
"upload_time": "2024-05-17T17:54:45",
"upload_time_iso_8601": "2024-05-17T17:54:45.855460Z",
"url": "https://files.pythonhosted.org/packages/5e/8e/f8075faa8bf72e0e9afe232ee0c4827a6ddf472151e57386e8b53337d484/jolt-0.9.221.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-17 17:54:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "srand",
"github_project": "jolt",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "jolt"
}
JSON
