hmd-cli-build


Namehmd-cli-build JSON
Version 0.1.56 PyPI version JSON
download
home_page
SummaryGeneric build tool.
upload_time2024-01-10 21:50:47
maintainer
docs_urlNone
authorJim Majure
requires_python
licenseApache 2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            .. HMD hmd-cli-build documentation master file

hmd-cli-build
===============================================================
Generic build tool for NeuronSphere compliant projects.

Declaring Build Steps
--------------------------

A NeuronSphere Project declares which HMD CLI commands are required to build it in the `./meta-data/manifest.json` file.
The package `hmd-cli-build` installs a general build command, `hmd build` that handles calling each required command in order.
The `hmd build` command reads the `./meta-data/manifest.json`, and attempts to run the HMD tools
listed in the `build.commands` section.
The tools listed must be installed separately (most are included in the `neuronsphere` package).

Example:

.. code-block:: json

    {
      "name": "example-project",
      "build": {
        "commands": [["mickey"], ["python"]]
      }
    }

In the above example, `hmd build` will first run `hmd mickey build` and then `hmd python build`.
If a build command errors or fails, the entire build will exit and fail.
All subsequent commands listed will not be called.
Build commands are run sequentially in the order listed.
It is not possible to run commands in parallel.

Strict Mode
------------------

By default, `hmd build` runs with `HMD_BUILD_STRICT_MODE=true`, or in **strict mode**.
While in **strict mode**, the build will error and fail if one of the listed build commands is not installed.
This behavior is desirable on a CI or build server, but not for local development.
You can turn off **strict mode** by setting `HMD_BUILD_STRICT_MODE=false`.
This will be set for you when you run `hmd configure` after installing the `neuronsphere` package.

When **strict mode** is disabled, `hmd build` will only warn about a missing command and continue on to the next command.

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "hmd-cli-build",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Jim Majure",
    "author_email": "jim.majure@hmdlabs.io",
    "download_url": "",
    "platform": null,
    "description": ".. HMD hmd-cli-build documentation master file\n\nhmd-cli-build\n===============================================================\nGeneric build tool for NeuronSphere compliant projects.\n\nDeclaring Build Steps\n--------------------------\n\nA NeuronSphere Project declares which HMD CLI commands are required to build it in the `./meta-data/manifest.json` file.\nThe package `hmd-cli-build` installs a general build command, `hmd build` that handles calling each required command in order.\nThe `hmd build` command reads the `./meta-data/manifest.json`, and attempts to run the HMD tools\nlisted in the `build.commands` section.\nThe tools listed must be installed separately (most are included in the `neuronsphere` package).\n\nExample:\n\n.. code-block:: json\n\n    {\n      \"name\": \"example-project\",\n      \"build\": {\n        \"commands\": [[\"mickey\"], [\"python\"]]\n      }\n    }\n\nIn the above example, `hmd build` will first run `hmd mickey build` and then `hmd python build`.\nIf a build command errors or fails, the entire build will exit and fail.\nAll subsequent commands listed will not be called.\nBuild commands are run sequentially in the order listed.\nIt is not possible to run commands in parallel.\n\nStrict Mode\n------------------\n\nBy default, `hmd build` runs with `HMD_BUILD_STRICT_MODE=true`, or in **strict mode**.\nWhile in **strict mode**, the build will error and fail if one of the listed build commands is not installed.\nThis behavior is desirable on a CI or build server, but not for local development.\nYou can turn off **strict mode** by setting `HMD_BUILD_STRICT_MODE=false`.\nThis will be set for you when you run `hmd configure` after installing the `neuronsphere` package.\n\nWhen **strict mode** is disabled, `hmd build` will only warn about a missing command and continue on to the next command.\n\n\n\n",
    "bugtrack_url": null,
    "license": "Apache 2.0",
    "summary": "Generic build tool.",
    "version": "0.1.56",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "06966ed52fff05bb5ef29f36599d2e8850f792405ff6a7c60c0860243c93b661",
                "md5": "b41838b49094823818fd388fbf191216",
                "sha256": "b0fadb738a208cb35618b1e3e64859ee9331deb058176474002170f7ba203fbe"
            },
            "downloads": -1,
            "filename": "hmd_cli_build-0.1.56-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b41838b49094823818fd388fbf191216",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 5323,
            "upload_time": "2024-01-10T21:50:47",
            "upload_time_iso_8601": "2024-01-10T21:50:47.806597Z",
            "url": "https://files.pythonhosted.org/packages/06/96/6ed52fff05bb5ef29f36599d2e8850f792405ff6a7c60c0860243c93b661/hmd_cli_build-0.1.56-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-10 21:50:47",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "hmd-cli-build"
}
Jim Majure
Elapsed time: 0.43526s