colcon-alias


Namecolcon-alias JSON
Version 0.1.1 PyPI version JSON
download
home_pagehttps://github.com/colcon/colcon-alias/
SummaryExtension for colcon to create and modify command aliases.
upload_time2024-06-24 21:48:32
maintainerScott K Logan
docs_urlNone
authorScott K Logan
requires_python>=3.6
licenseApache License, Version 2.0
keywords colcon
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            colcon-alias
============

An extension for `colcon-core <https://github.com/colcon/colcon-core>`_ to create and modify command aliases.

Aliases condense any number of colcon command invocations made up of a verb followed by all associated arguments down to another 'alias' verb. When invoking the alias verb, additional arguments can be appended to the original invocations.

An example alias called 'bat', short for 'build and test'::

    $ colcon alias bat --command build --command test
    Registered command list for alias 'bat':
      build
      test
    $ colcon bat --packages-select colcon-alias
    Running command alias: colcon build --packages-select colcon-alias
    ...
    Running command alias: colcon test --packages-select colcon-alias
    ...

Another example, an alias for building specific packages::

    $ colcon alias buildpkg --command build --event-handler console_direct+ --packages-select
    Registered command list for alias 'buildpkg':
      build --event-handler console_direct+ --packages-select
    $ colcon buildpkg colcon-alias
    Running command alias: colcon build --event-handler console_direct+ --packages-select colcon-alias
    ...

A list of currently registered aliases can be found in the colcon help text::

    $ colcon --help
    ...

    colcon aliases:
      bat                   build
                            test
      buildpkg              build --event-handler console_direct+ --packages-select

    ...

Note: When using ``colcon-alias`` with the ``colcon-mixin`` extension, the ``--mixin`` command line argument is applied as an argument to ``--command`` and not used as an actual mixin to the ``alias`` verb.



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/colcon/colcon-alias/",
    "name": "colcon-alias",
    "maintainer": "Scott K Logan",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "logans@cottsay.net",
    "keywords": "colcon",
    "author": "Scott K Logan",
    "author_email": "logans@cottsay.net",
    "download_url": "https://files.pythonhosted.org/packages/ae/b1/db59479e8aeb3358c6fee436c3dfdaf3ffc412ab7d58ab6be0a647d81647/colcon-alias-0.1.1.tar.gz",
    "platform": null,
    "description": "colcon-alias\n============\n\nAn extension for `colcon-core <https://github.com/colcon/colcon-core>`_ to create and modify command aliases.\n\nAliases condense any number of colcon command invocations made up of a verb followed by all associated arguments down to another 'alias' verb. When invoking the alias verb, additional arguments can be appended to the original invocations.\n\nAn example alias called 'bat', short for 'build and test'::\n\n    $ colcon alias bat --command build --command test\n    Registered command list for alias 'bat':\n      build\n      test\n    $ colcon bat --packages-select colcon-alias\n    Running command alias: colcon build --packages-select colcon-alias\n    ...\n    Running command alias: colcon test --packages-select colcon-alias\n    ...\n\nAnother example, an alias for building specific packages::\n\n    $ colcon alias buildpkg --command build --event-handler console_direct+ --packages-select\n    Registered command list for alias 'buildpkg':\n      build --event-handler console_direct+ --packages-select\n    $ colcon buildpkg colcon-alias\n    Running command alias: colcon build --event-handler console_direct+ --packages-select colcon-alias\n    ...\n\nA list of currently registered aliases can be found in the colcon help text::\n\n    $ colcon --help\n    ...\n\n    colcon aliases:\n      bat                   build\n                            test\n      buildpkg              build --event-handler console_direct+ --packages-select\n\n    ...\n\nNote: When using ``colcon-alias`` with the ``colcon-mixin`` extension, the ``--mixin`` command line argument is applied as an argument to ``--command`` and not used as an actual mixin to the ``alias`` verb.\n\n\n",
    "bugtrack_url": null,
    "license": "Apache License, Version 2.0",
    "summary": "Extension for colcon to create and modify command aliases.",
    "version": "0.1.1",
    "project_urls": {
        "Changelog": "https://github.com/colcon/colcon-alias/milestones?direction=desc&sort=due_date&state=closed",
        "GitHub": "https://github.com/colcon/colcon-alias/",
        "Homepage": "https://github.com/colcon/colcon-alias/"
    },
    "split_keywords": [
        "colcon"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cc40da1c2f983dac5889f6887679cab4ad93cc787b35cf839b0107812aa1bb24",
                "md5": "89bcb0363f5f00fa4e45fa2e3d3f4049",
                "sha256": "5b63fc7ff8f95e4caf47098811e2964faf65c42435a103845723dde0fc6d3ae9"
            },
            "downloads": -1,
            "filename": "colcon_alias-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "89bcb0363f5f00fa4e45fa2e3d3f4049",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 11839,
            "upload_time": "2024-06-24T21:48:31",
            "upload_time_iso_8601": "2024-06-24T21:48:31.413268Z",
            "url": "https://files.pythonhosted.org/packages/cc/40/da1c2f983dac5889f6887679cab4ad93cc787b35cf839b0107812aa1bb24/colcon_alias-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "aeb1db59479e8aeb3358c6fee436c3dfdaf3ffc412ab7d58ab6be0a647d81647",
                "md5": "2489740146bedb114efff2b26d1bff1d",
                "sha256": "0e552843806078eed85f6b29023fb548e2707837d8a48c90fbd69a97e77d4d03"
            },
            "downloads": -1,
            "filename": "colcon-alias-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "2489740146bedb114efff2b26d1bff1d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 12892,
            "upload_time": "2024-06-24T21:48:32",
            "upload_time_iso_8601": "2024-06-24T21:48:32.512848Z",
            "url": "https://files.pythonhosted.org/packages/ae/b1/db59479e8aeb3358c6fee436c3dfdaf3ffc412ab7d58ab6be0a647d81647/colcon-alias-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-24 21:48:32",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "colcon",
    "github_project": "colcon-alias",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "colcon-alias"
}
        
Elapsed time: 6.49889s