Skip to main content

The git_well module

Project description

Pypi PypiDownloads GithubActions Codecov ReadTheDocs

Read the docs

https://python-git-well.readthedocs.io

Github

https://github.com/Erotemic/git_well

Pypi

https://pypi-hypernode.com/project/git_well

Git Well is a collection of git command line tools and is also a Python module.

Installing this module installs the git-well command, which is a modal CLI into several new git commands. These git commands are also exposed as standalone “git” executables.

In other words after you:

pip install git-well

To get CLI argument completion install autocomplete, and you can enable global auto-completion

pip install argcomplete
mkdir -p ~/.bash_completion.d
activate-global-python-argcomplete --dest ~/.bash_completion.d
source ~/.bash_completion.d/python-argcomplete

And add this to your .bashrc

if [ -f "$HOME/.bash_completion.d/python-argcomplete" ]; then
    # shellcheck disable=SC1091
    source "$HOME"/.bash_completion.d/python-argcomplete
fi

NOTE: if you know of a way to make this easier please let me know!

Then you can run

# Show all the commands exposed by this repo.
git well --help

git well sync --help

# OR

git sync

Top Level CLI:

usage: git-well [-h] {squash_streaks,branch_upgrade,sync,branch_cleanup,track_upstream,rebase_add_continue,remote_protocol,discover_remote} ...

options:
  -h, --help            show this help message and exit

commands:
  {squash_streaks,branch_upgrade,sync,branch_cleanup,track_upstream,rebase_add_continue,remote_protocol,discover_remote}
                        specify a command to run
    squash_streaks      Squashes consecutive commits that meet a specified criteiron.
    branch_upgrade      Upgrade to the latest "dev" branch. I.e. search for the branch
    sync                Sync a git repo with a remote server via ssh
    branch_cleanup      Cleanup branches that have been merged into main.
    track_upstream      Set the branch upstream with sensible defaults if possible.
    rebase_add_continue
                        A single step to make rebasing easier.
    remote_protocol     Helper to change a remote from https to ssh / git for a specific user /
    discover_remote     Attempt to discover a ssh remote based on an ssh host.

The tools in this module are derived from:

Use Cases

Have you ever run into this error when you run git pull?

There is no tracking information for the current branch.
Please specify which branch you want to merge with.
See git-pull(1) for details.

    git pull <remote> <branch>

If you wish to set tracking information for this branch you can do so with:

    git branch --set-upstream-to=origin/<branch> the_current_branch

I find this a huge pain because it can’t even be bothered to fill in <branch> so you have to munge the command to type:

git branch --set-upstream-to=origin/the_current_branch the_current_branch

I get why they did this, the branch on the remote might have a different name. But… it usually doesn’t. That’s why I implemented git-well track-upstream.

Running this instead will detect if you are in the simple case and just do it for you. Otherwise it will enumerate your options and ask you to pick one.

I’ve found this command to prevent so much disruption that instaling git-well install git track-upstream as its own command.

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

git_well-0.2.1.tar.gz (42.5 kB view details)

Uploaded Source

Built Distribution

git_well-0.2.1-py3-none-any.whl (46.0 kB view details)

Uploaded Python 3

File details

Details for the file git_well-0.2.1.tar.gz.

File metadata

  • Download URL: git_well-0.2.1.tar.gz
  • Upload date:
  • Size: 42.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.12

File hashes

Hashes for git_well-0.2.1.tar.gz
Algorithm Hash digest
SHA256 1d96a1867595c091617b943cfb145228f4c012b88148acd7e9912fa62298e104
MD5 f89a9d841bffbb0550f26d6bb6282f10
BLAKE2b-256 426bf950847765e10fe842fcf68bd3462dec3071caab448db9d38e74034e034a

See more details on using hashes here.

File details

Details for the file git_well-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: git_well-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 46.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.12

File hashes

Hashes for git_well-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 349028e5a98afbb3e255c0770b816da2ca4a20122ac99d3aa75717b60c1891fc
MD5 9f357d02d1ff0e26a72d4fecff15bdd0
BLAKE2b-256 9b681140f83be44c8d1f366b2d0a2d27ea4eafe6c17544f7cd67c5b8cbc63699

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