{ "info": { "author": "Shane Loretz", "author_email": "shane.loretz@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Environment :: Plugins", "Intended Audience :: Developers", "License :: OSI Approved :: Apache Software License", "Operating System :: POSIX", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Topic :: Software Development :: Build Tools" ], "description": "==================\nColcon Spawn Shell\n==================\n\nIntroduction\n------------\n\nThis is a `colcon `_ plugin to chain workspaces in new shells.\nIt allows quickly un-chaining workspaces by exiting the spawned shell.\n\nThe shell's prompt is edited to show the workspace order.\nThe only supported shell is **bash**.\n\n.. image:: https://raw.githubusercontent.com/colcon/colcon-spawn-shell/8de6d0a687619bfd8342647b6d216695bb76dfaf/doc/colcon_spawn_shell_example.gif\n\nQuick Start\n-----------\n\n**Optional:** Create and source a virtual environment.\n\n .. code-block:: bash\n\n python3 -m venv env\n . env/bin/activate\n\nFrom Pip\n~~~~~~~~\n\n1. Download ``colcon-spawn-shell`` from pip.\n\n .. code-block:: bash\n\n pip install colcon-spawn-shell\n\n2. Build the colcon workspace you would like to spawn in a new shell.\n\n .. code-block:: bash\n\n cd my_cool_workspace\n colcon build\n\n3. Source ``spawn_shell.bash`` to activate the workspace.\n\n .. code-block:: bash\n\n . install/spawn_shell.bash\n\n_`From Source`\n~~~~~~~~~~~~~~\n\n.. note::\n\n It's recommended to install to a virutal environment for development.\n See `this tutorial `_ for more information.\n\n1. Download the source code for ``colcon-spawn-shell``\n\n .. code-block:: bash\n\n mkdir -b spawn_shell_ws/src\n cd spawn_shell_ws/src\n git clone https://github.com/colcon/colcon-spawn-shell.git\n\n2. Build the workspace using colcon\n\n .. code-block:: bash\n\n colcon build\n\n3. Source the workspace\n\n .. code-block:: bash\n\n . install/local_setup.bash\n\nFrom now on future workspaces can be activated by sourcing ``spawn_shell.bash``\n\n .. code-block:: bash\n\n cd my_cool_workspace\n colcon build\n . install/spawn_shell.bash\n\nContributing\n------------\n\n1. `Fork `_ the `colcon/colcon-spawn-shell `_ repository.\n2. Follow the `\"From Source\" instructions `_, except clone your forked repository.\n3. Make changes and commit them to a branch.\n\n .. code-block:: bash\n\n # Creat a branch for your changes\n git checkout -b my-cool-changes\n # Make your changes ...\n git commit -m \"committing my changes\"\n # Push them to your fork\n git push --set-upstream origin my-cool-changes\n\n4. Create a `Pull Request `_ from your branch to the branch **develop** on `colcon/colcon-spawn-shell `_\n\n\n.. note::\n\n Please create pull requests from the branch **develop** because `this repository `_ uses the `nvie git branching model `_.\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "https://github.com/colcon/colcon-spawn-shell/archive/0.2.0.tar.gz", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/colcon/colcon-spawn-shell", "keywords": "", "license": "Apache License, Version 2.0", "maintainer": "Shane Loretz", "maintainer_email": "shane.loretz@gmail.com", "name": "colcon-spawn-shell", "package_url": "https://pypi.org/project/colcon-spawn-shell/", "platform": "", "project_url": "https://pypi.org/project/colcon-spawn-shell/", "project_urls": { "Download": "https://github.com/colcon/colcon-spawn-shell/archive/0.2.0.tar.gz", "Homepage": "http://github.com/colcon/colcon-spawn-shell" }, "release_url": "https://pypi.org/project/colcon-spawn-shell/0.2.0/", "requires_dist": [ "colcon-core (>=0.3.1)", "colcon-bash (>=0.3.0)" ], "requires_python": "", "summary": "Source colcon workspaces in a new shell.", "version": "0.2.0" }, "last_serial": 4066696, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "538038cffbdf26cd68188b38b53d29d2", "sha256": "b332dc6235f72e803538b3252735777f882d3f5dd6c26733272aad993f3e3c95" }, "downloads": -1, "filename": "colcon_spawn_shell-0.1.0-py3.5.egg", "has_sig": false, "md5_digest": "538038cffbdf26cd68188b38b53d29d2", "packagetype": "bdist_egg", "python_version": "3.5", "requires_python": null, "size": 7210, "upload_time": "2018-06-03T23:40:06", "url": "https://files.pythonhosted.org/packages/e9/b0/cee1e94e410d46812f2d9f0c9bcca31e0faec65cedcd44cc4224fc954917/colcon_spawn_shell-0.1.0-py3.5.egg" }, { "comment_text": "", "digests": { "md5": "519c0d4b9b91ce4d2130757faca3639b", "sha256": "b145c6315292ad94c76c4908e9a3f224cedd5bef01811b63b199e4c6d5357650" }, "downloads": -1, "filename": "colcon-spawn-shell-0.1.0.tar.gz", "has_sig": false, "md5_digest": "519c0d4b9b91ce4d2130757faca3639b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4473, "upload_time": "2018-06-03T23:40:07", "url": "https://files.pythonhosted.org/packages/3b/85/635ec5806a4f59998ba2e248c5a9bf698f17979003267e61d26d85a21a23/colcon-spawn-shell-0.1.0.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "b636845afe06253c6460a7cf33af4e50", "sha256": "41870555b1cc182867c7f986a44648fb4ceae9c99edf4049a830ed6047cd7b33" }, "downloads": -1, "filename": "colcon_spawn_shell-0.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "b636845afe06253c6460a7cf33af4e50", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5710, "upload_time": "2018-07-16T18:19:29", "url": "https://files.pythonhosted.org/packages/83/49/5dc78513c6fba14d4ec27394aa3e1e51484e3f326598ee7d1e5d11a4c88d/colcon_spawn_shell-0.2.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d43ed2bcf1772b0c021a956bd8a36dc7", "sha256": "906beea1db97f6d648436312df6cafb009cb22a871dad6dc55f54ca5b16918f2" }, "downloads": -1, "filename": "colcon-spawn-shell-0.2.0.tar.gz", "has_sig": false, "md5_digest": "d43ed2bcf1772b0c021a956bd8a36dc7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4466, "upload_time": "2018-07-16T18:19:30", "url": "https://files.pythonhosted.org/packages/88/10/464d5811293f2e5e8ef13423b920099b35525ec1fae67503efbd48b0a869/colcon-spawn-shell-0.2.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "b636845afe06253c6460a7cf33af4e50", "sha256": "41870555b1cc182867c7f986a44648fb4ceae9c99edf4049a830ed6047cd7b33" }, "downloads": -1, "filename": "colcon_spawn_shell-0.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "b636845afe06253c6460a7cf33af4e50", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5710, "upload_time": "2018-07-16T18:19:29", "url": "https://files.pythonhosted.org/packages/83/49/5dc78513c6fba14d4ec27394aa3e1e51484e3f326598ee7d1e5d11a4c88d/colcon_spawn_shell-0.2.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d43ed2bcf1772b0c021a956bd8a36dc7", "sha256": "906beea1db97f6d648436312df6cafb009cb22a871dad6dc55f54ca5b16918f2" }, "downloads": -1, "filename": "colcon-spawn-shell-0.2.0.tar.gz", "has_sig": false, "md5_digest": "d43ed2bcf1772b0c021a956bd8a36dc7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4466, "upload_time": "2018-07-16T18:19:30", "url": "https://files.pythonhosted.org/packages/88/10/464d5811293f2e5e8ef13423b920099b35525ec1fae67503efbd48b0a869/colcon-spawn-shell-0.2.0.tar.gz" } ] }