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.

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.1.0.tar.gz (4.5 kB view details)

Uploaded Source

Built Distribution

colcon_spawn_shell-0.1.0-py3.5.egg (7.2 kB view details)

Uploaded Source

File details

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

File metadata

File hashes

Hashes for colcon-spawn-shell-0.1.0.tar.gz
Algorithm Hash digest
SHA256 b145c6315292ad94c76c4908e9a3f224cedd5bef01811b63b199e4c6d5357650
MD5 519c0d4b9b91ce4d2130757faca3639b
BLAKE2b-256 3b85635ec5806a4f59998ba2e248c5a9bf698f17979003267e61d26d85a21a23

See more details on using hashes here.

File details

Details for the file colcon_spawn_shell-0.1.0-py3.5.egg.

File metadata

File hashes

Hashes for colcon_spawn_shell-0.1.0-py3.5.egg
Algorithm Hash digest
SHA256 b332dc6235f72e803538b3252735777f882d3f5dd6c26733272aad993f3e3c95
MD5 538038cffbdf26cd68188b38b53d29d2
BLAKE2b-256 e9b0cee1e94e410d46812f2d9f0c9bcca31e0faec65cedcd44cc4224fc954917

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