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

Uploaded Source

Built Distribution

colcon_spawn_shell-0.3.0-py3-none-any.whl (10.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: colcon-spawn-shell-0.3.0.tar.gz
  • Upload date:
  • Size: 9.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.4.2 requests/2.22.0 setuptools/59.8.0 requests-toolbelt/0.8.0 tqdm/4.30.0 CPython/3.8.10

File hashes

Hashes for colcon-spawn-shell-0.3.0.tar.gz
Algorithm Hash digest
SHA256 2f2be7a5af61b882126a01b63409985b9c7d1d3c4d5adb5c5a63728d20ba0d4a
MD5 8435571659c8a6757803bb9bf75ca461
BLAKE2b-256 4c0cc36da63c1c0217f96621d64d2ec8e10b4823b0cc06eb323f902476fc87ea

See more details on using hashes here.

File details

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

File metadata

  • Download URL: colcon_spawn_shell-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 10.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.4.2 requests/2.22.0 setuptools/59.8.0 requests-toolbelt/0.8.0 tqdm/4.30.0 CPython/3.8.10

File hashes

Hashes for colcon_spawn_shell-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d3841699539db2a2d68d9de598b01edc0c7d69b46ff20c7b1ecd510c1e3e2ff2
MD5 3282819b757aa1487e95bc2049a8660e
BLAKE2b-256 71981d49411e3442cf8160cd6a75842a9e0d4dc79102ced778ce0747a1d4de80

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