Skip to main content

Source colcon workspaces in a new shell.

Project description

Introduction

This is a colcon plugin to chain workspaces in new shells. It allows quickly un-chaining workspaces by exiting the spawned shell.

The shell’s prompt is edited to show the workspace order. The only supported shell is bash.

https://raw.githubusercontent.com/colcon/colcon-spawn-shell/8de6d0a687619bfd8342647b6d216695bb76dfaf/doc/colcon_spawn_shell_example.gif

Quick Start

Optional: Create and source a virtual environment.

python3 -m venv env
. env/bin/activate

From Pip

  1. Download colcon-spawn-shell from pip.

    pip install colcon-spawn-shell
  2. Build the colcon workspace you would like to spawn in a new shell.

    cd my_cool_workspace
    colcon build
  3. Source spawn_shell.bash to activate the workspace.

    . install/spawn_shell.bash

From Source

  1. Download the source code for colcon-spawn-shell

    mkdir -b spawn_shell_ws/src
    cd spawn_shell_ws/src
    git clone https://github.com/colcon/colcon-spawn-shell.git
  2. Build the workspace using colcon

    colcon build
  3. Source the workspace

    . install/local_setup.bash

From now on future workspaces can be activated by sourcing spawn_shell.bash

cd my_cool_workspace
colcon build
. install/spawn_shell.bash

Contributing

  1. Fork the colcon/colcon-spawn-shell repository.

  2. Follow the “From Source” instructions, except clone your forked repository.

  3. Make changes and commit them to a branch.

    # Creat a branch for your changes
    git checkout -b my-cool-changes
    # Make your changes ...
    git commit -m "committing my changes"
    # Push them to your fork
    git push --set-upstream origin my-cool-changes
  4. Create a Pull Request from your branch to the branch develop on colcon/colcon-spawn-shell

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

colcon-spawn-shell-0.2.0.tar.gz (4.5 kB view details)

Uploaded Source

Built Distribution

colcon_spawn_shell-0.2.0-py3-none-any.whl (5.7 kB view details)

Uploaded Python 3

File details

Details for the file colcon-spawn-shell-0.2.0.tar.gz.

File metadata

File hashes

Hashes for colcon-spawn-shell-0.2.0.tar.gz
Algorithm Hash digest
SHA256 906beea1db97f6d648436312df6cafb009cb22a871dad6dc55f54ca5b16918f2
MD5 d43ed2bcf1772b0c021a956bd8a36dc7
BLAKE2b-256 8810464d5811293f2e5e8ef13423b920099b35525ec1fae67503efbd48b0a869

See more details on using hashes here.

File details

Details for the file colcon_spawn_shell-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for colcon_spawn_shell-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 41870555b1cc182867c7f986a44648fb4ceae9c99edf4049a830ed6047cd7b33
MD5 b636845afe06253c6460a7cf33af4e50
BLAKE2b-256 83495dc78513c6fba14d4ec27394aa3e1e51484e3f326598ee7d1e5d11a4c88d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page