Skip to main content

Bookmark system between development branches.

Project description

# Squirrel Bookmarks

Bookmark system between development branches.


## Why?

When I am at work, it's common to work on multiple development branches simultaneously.

For example, when I am developing a new feature on a feature branch `feature-param-validation`, I want
to run a local environment of production branch `production`. Meanwhile, our QA found a critical bug on
the other feature branch `feature-remove-tokens`.

What do I do?

Single clone of the working repository is not enough for me. So I clone multiple copies of the
repositories in my local machine. You can see many directories in the directory of my `~/dev`, and
each directory is a development branch, e.g. `feature-param-validation`, `feature-remove-tokens`,
`production`, etc.

Then it's time for Squirrel Bookmarks. Basically it can do the following 2 things:

- Switch to a bookmark quickly: When I am doing my development, there are some directories that
I frequently `cd` into. For example, I often `cd` into `client-side/js/components` and `server-side/src/resources`.
So I need bookmarks for those directories.

- Switch to a branch quickly: I also want to switch between branches quickly. As mentioned above, I have
multiple branches: `feature-param-validation`, `feature-remove-tokens`, `production`, etc.

Example usage will be like:

```
$ sq feature-param-validation
jump to /Users/johnlinp/dev/feature-param-validation
$ sq components
jump to /Users/johnlinp/dev/feature-param-validation/client-side/js/components
$ cd checkbox
$ pwd
/Users/johnlinp/dev/feature-param-validation/client-side/js/components/checkbox
$ sq production
jump to /Users/johnlinp/dev/production/client-side/js/components/checkbox
$ sq resources
jump to /Users/johnlinp/dev/production/server-side/src/resources
```


## Requirement

Currently only supports Python 3.5+.


## Operation System

Currently tested on:

- macOS 10.13.6 (High Sierra)
- Ubuntu 18.04 (Bionic Beaver)


## Install

Please type:

```
$ sudo pip3 install squirrel-bookmarks
```

to install.


## Setup Config

You have to setup config first.

Please type:

```
$ squirrel init-config
```

to initialize your bookmark config at `~/.squirrel.json`.

After that, please edit `~/.squirrel.json` to meet your needs.


## Usage

When you want to jump to a branch called `production`, please type:

```
$ sq production
```

When you want to jump to a bookmark named `components`, please type:

```
$ sq components
```


Project details


Download files

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

Files for squirrel-bookmarks, version 0.1.6
Filename, size File type Python version Upload date Hashes
Filename, size squirrel_bookmarks-0.1.6-py3-none-any.whl (8.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size squirrel-bookmarks-0.1.6.tar.gz (3.6 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page