README.md

   1 # git-cola: The highly caffeinated Git GUI
   2
   3     git-cola is a powerful Git GUI with a slick and intuitive user interface.
   4
   5     Copyright (C) 2007-2018, David Aguilar and contributors
   6
   7     This program is free software: you can redistribute it and/or modify
   8     it under the terms of the GNU General Public License as published by
   9     the Free Software Foundation, either version 2 of the License, or
  10     (at your option) any later version.
  11
  12     This program is distributed in the hope that it will be useful,
  13     but WITHOUT ANY WARRANTY; without even the implied warranty of
  14     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15     GNU General Public License for more details.
  16
  17     You should have received a copy of the GNU General Public License
  18     along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20 ## SCREENSHOTS
  21
  22 Screenshots are available on the
  23 [git-cola screenshots page](https://git-cola.github.io/screenshots.html).
  24
  25 ## DOWNLOAD
  26
  27     apt-get install git-cola
  28
  29 New releases are available on the
  30 [git-cola download page](https://git-cola.github.io/downloads.html).
  31
  32 ## FORK
  33
  34     git clone git://github.com/git-cola/git-cola.git
  35
  36 [![git-cola build status](https://api.travis-ci.org/git-cola/git-cola.svg?branch=master)](https://travis-ci.org/git-cola/git-cola)
  37
  38 [git-cola on github](https://github.com/git-cola/git-cola)
  39
  40 [git-cola google group](https://groups.google.com/group/git-cola/)
  41
  42
  43 # NUTRITIONAL FACTS
  44
  45 ## ACTIVE INGREDIENTS
  46
  47 * [git](https://git-scm.com/) 1.6.3 or newer.
  48
  49 * [Python](https://python.org/) 2.6 or newer (Python 2+3 compatible).
  50
  51 * [QtPy](https://github.com/spyder-ide/qtpy) 1.1.0 or newer.
  52
  53 * [argparse](https://pypi.python.org/pypi/argparse) 1.1 or newer.
  54   argparse is part of the stdlib in Python 2.7; install argparse separately if
  55   you are running on Python 2.6.
  56
  57 * [Sphinx](http://sphinx-doc.org/) for building the documentation.
  58
  59 *git-cola* uses *QtPy*, so you can choose between *PyQt4*, *PyQt5*, and
  60 *PySide* by setting the `QT_API` environment variable to `pyqt4`, `pyqt5` or
  61 `pyside` as desired.  `qtpy` defaults to `pyqt5` and falls back to `pyqt4`
  62 if `pyqt5` is not installed.
  63
  64 Any of the following Python Qt libraries must be installed:
  65
  66 * [PyQt4](https://www.riverbankcomputing.com/software/pyqt/download)
  67   4.6 or newer
  68
  69 * [PyQt5](https://www.riverbankcomputing.com/software/pyqt/download5)
  70   5.2 or newer
  71
  72 * [PySide](https://github.com/PySide/PySide)
  73   1.1.0 or newer
  74
  75 Set `QT_API=pyqt4` in your environment if you have both
  76 versions of *PyQt* installed and want to ensure that PyQt4 is used.
  77
  78 *NOTE*: *git-cola* includes a vendored copy of its *QtPy* dependency.
  79
  80 We provide a copy of the `qtpy` module when installing *git-cola* so that you
  81 are not required to install *QtPy* separately.  If you'd like to provide your
  82 own `qtpy` module, for example from the `python-qtpy` Debian package, then use
  83 `make NO_VENDOR_LIBS=1 ...` when invoking `make`, or export
  84 `GIT_COLA_NO_VENDOR_LIBS=1` into the build environment.
  85
  86 Python3 users on debian will need to install `python3-distutils` in order
  87 to run the Makefile's installation steps.  `distutils` is a Python build
  88 requirement, but not needed at runtime.
  89
  90
  91 ## ADDITIVES
  92
  93 *git-cola* enables additional features when the following
  94 Python modules are installed.
  95
  96 [send2trash](https://github.com/hsoft/send2trash) enables cross-platform
  97 "Send to Trash" functionality.
  98
  99 # BREWING INSTRUCTIONS
 100
 101 ## RUN FROM SOURCE
 102
 103 You don't need to install *git-cola* to run it.
 104 Running *git-cola* from its source tree is the easiest
 105 way to try the latest version.
 106
 107     git clone git://github.com/git-cola/git-cola.git
 108     cd git-cola
 109     ./bin/git-cola
 110     ./bin/git-dag
 111
 112 Having *git-cola*'s *bin/* directory in your path allows you to run
 113 *git cola* like a regular built-in Git command:
 114
 115     # Replace "$PWD/bin" with the path to git-cola's bin/ directory
 116     PATH="$PWD/bin":"$PATH"
 117     export PATH
 118
 119     git cola
 120     git dag
 121
 122 The instructions below assume that you have *git-cola* present in your
 123 `$PATH`.  Replace "git cola" with "./bin/git-cola" as needed if you'd like to
 124 just run it in-place.
 125
 126 # DOCUMENTATION
 127
 128 * [HTML documentation](https://git-cola.readthedocs.io/en/latest/)
 129
 130 * [git-cola manual](share/doc/git-cola/git-cola.rst)
 131
 132 * [git-dag manual](share/doc/git-cola/git-dag.rst)
 133
 134 * [Keyboard shortcuts](https://git-cola.github.io/share/doc/git-cola/hotkeys.html)
 135
 136 * [Contributing guidelines](CONTRIBUTING.md)
 137
 138 # INSTALLATION
 139
 140 Normally you can just do "make install" to install *git-cola*
 141 in your `$HOME` directory (`$HOME/bin`, `$HOME/share`, etc).
 142 If you want to do a global install you can do
 143
 144     make prefix=/usr install
 145
 146 The platform-specific installation methods below use the native
 147 package manager.  You should use one of these so that all of *git-cola*'s
 148 dependencies are installed.
 149
 150 Distutils is used by the `Makefile` via `setup.py` to install *git-cola* and
 151 its launcher scripts.  distutils replaces the `#!/usr/bin/env python` lines in
 152 scripts with the full path to python at build time, which can be undesirable
 153 when the runtime python is not the same as the build-time python.  To disable
 154 the replacement of the `#!/usr/bin/env python` lines, pass `USE_ENV_PYTHON=1`
 155 to `make`.
 156
 157 ## LINUX
 158
 159 Linux is it! Your distro has probably already packaged git-cola.
 160 If not, please file a bug against your distribution ;-)
 161
 162 ### arch
 163
 164 Available in the [AUR](https://aur.archlinux.org/packages/git-cola/).
 165
 166 ### debian, ubuntu
 167
 168     apt-get install git-cola
 169
 170 ### fedora
 171
 172     dnf install git-cola
 173
 174 ### gentoo
 175
 176     emerge git-cola
 177
 178
 179 ## MAC OS X
 180
 181 [Homebrew](https://brew.sh/) is the easiest way to install
 182 git-cola's *Qt4* and *PyQt4* dependencies.  We will use Homebrew to install
 183 the git-cola recipe, but build our own .app bundle from source.
 184
 185 [Sphinx](http://sphinx-doc.org/latest/install.html) is used to build the
 186 documentation.
 187
 188     brew install sphinx-doc
 189     brew install git-cola
 190
 191 Once brew has installed git-cola you can:
 192
 193 1. Clone git-cola
 194
 195     `git clone git://github.com/git-cola/git-cola.git && cd git-cola`
 196
 197 2. Build the git-cola.app application bundle
 198
 199     ```
 200     make \
 201         PYTHON=$(brew --prefix python3)/bin/python3 \
 202         PYTHON_CONFIG=$(brew --prefix python3)/bin/python3-config \
 203         SPHINXBUILD=$(brew --prefix sphinx-doc)/bin/sphinx-build \
 204         git-cola.app
 205    ```
 206
 207 3. Copy it to _/Applications_
 208
 209     `rm -fr /Applications/git-cola.app && cp -r git-cola.app /Applications`
 210
 211 Newer versions of Homebrew install their own `python3` installation and
 212 provide the `PyQt5` modules for `python3` only.  You have to use
 213 `python3 ./bin/git-cola` when running from the source tree.
 214
 215 ### UPGRADING USING HOMEBREW
 216
 217 If you upgrade using `brew` then it is recommended that you re-install
 218 *git-cola*'s dependencies when upgrading.  Re-installing ensures that the
 219 Python modules provided by Homebrew will be properly setup.
 220
 221 This is required when upgrading to a modern (post-10.11 El Capitan) Mac OS X.
 222 Homebrew now bundles its own Python3 installation instead of using the
 223 system-provided default Python.
 224
 225
 226     # update homebrew
 227     brew update
 228
 229     # uninstall git-cola and its dependencies
 230     brew uninstall git-cola
 231     brew uninstall pyqt5
 232     brew uninstall sip
 233
 234     # re-install git-cola and its dependencies
 235     brew install git-cola
 236
 237 ## WINDOWS INSTALLATION
 238
 239 **IMPORTANT** If you have a 64-bit machine, install the 64-bit versions only.
 240 Do not mix 32-bit and 64-bit versions.
 241
 242 Download and install the following:
 243
 244 * [Git for Windows](https://git-for-windows.github.io/)
 245
 246 * [Git Cola](https://github.com/git-cola/git-cola/releases)
 247
 248 Once these are installed you can run *git cola* from the Start menu.
 249
 250 See "WINDOWS (continued)" below for more details.
 251
 252 # GOODIES
 253
 254 *git-cola* ships with an interactive rebase editor called *git-xbase*.
 255 *git-xbase* can be used to reorder and choose commits and is typically
 256 launched through the *git-cola*'s "Rebase" menu.
 257
 258 *git-xbase* can also be launched independently of the main *git-cola* interface
 259 by telling `git rebase` to use it as its editor:
 260
 261     env GIT_SEQUENCE_EDITOR="$PWD/share/git-cola/bin/git-xbase" \
 262     git rebase -i origin/master
 263
 264 The quickest way to launch *git-xbase* is via the *git cola rebase*
 265 sub-command (as well as various other sub-commands):
 266
 267     git cola rebase origin/master
 268
 269 # COMMAND-LINE TOOLS
 270
 271 The *git-cola* command exposes various sub-commands that allow you to quickly
 272 launch tools that are available from within the *git-cola* interface.
 273 For example, `./bin/git-cola find` launches the file finder,
 274 and `./bin/git-cola grep` launches the grep tool.
 275
 276 See `git cola --help-commands` for the full list of commands.
 277
 278     $ git cola --help-commands
 279     usage: git-cola [-h]
 280
 281                     {cola,am,archive,branch,browse,config,
 282                      dag,diff,fetch,find,grep,merge,pull,push,
 283                      rebase,remote,search,stash,tag,version}
 284                     ...
 285
 286     valid commands:
 287       {cola,am,archive,branch,browse,config,
 288        dag,diff,fetch,find,grep,merge,pull,push,
 289        rebase,remote,search,stash,tag,version}
 290
 291         cola                start git-cola
 292         am                  apply patches using "git am"
 293         archive             save an archive
 294         branch              create a branch
 295         browse              browse repository
 296         config              edit configuration
 297         dag                 start git-dag
 298         diff                view diffs
 299         fetch               fetch remotes
 300         find                find files
 301         grep                grep source
 302         merge               merge branches
 303         pull                pull remote branches
 304         push                push remote branches
 305         rebase              interactive rebase
 306         remote              edit remotes
 307         search              search commits
 308         stash               stash and unstash changes
 309         tag                 create tags
 310         version             print the version
 311
 312 ## HACKING
 313
 314 The following commands should be run during development:
 315
 316     # Run the unit tests
 317     $ make test
 318
 319     # Check for pylint and flake8 warnings
 320     $ make precommit
 321
 322     # Run tests against multiple python interpretors using tox
 323     $ make tox
 324
 325 The test suite can be found in the [test](test) directory.
 326
 327 The tests are setup to run automatically when code is pushed using
 328 [Travis CI](https://travis-ci.org/git-cola/git-cola).
 329 Checkout the [Travis config file](.travis.yml) for more details.
 330
 331 Auto-format `po/*.po` files before committing when updating translations:
 332
 333     $ make po
 334
 335 When submitting patches, consult the [contributing guidelines](CONTRIBUTING.md).
 336
 337 # WINDOWS (continued)
 338
 339 ## Development
 340
 341 In order to develop *git cola* on Windows you will need to install
 342 Python3 and pip.  Install PyQt5 using `pip install PyQt5`
 343 to make the PyQt5 bindings available to Python.
 344
 345 Once these are installed you can use `python.exe` to run
 346 directly from the source tree.  For example, from a Git Bash terminal:
 347
 348     /c/Python36/python.exe ./bin/git-cola
 349
 350 ## Multiple Python versions
 351
 352 If you have multiple versions of Python installed, the `contrib/win32/cola`
 353 launcher script might choose the newer version instead of the python
 354 that has PyQt installed.  In order to resolve this, you can set the
 355 `cola.pythonlocation` git configuration variable to tell cola where to
 356 find python.  For example:
 357
 358     git config --global cola.pythonlocation /c/Python36
 359
 360 ## BUILDING WINDOWS INSTALLERS
 361
 362 Windows installers are built using
 363
 364 * [Pynsist](https://pynsist.readthedocs.io/en/latest/).
 365
 366 * [NSIS](http://nsis.sourceforge.net/Main_Page) is also needed.
 367
 368 To build the installer using *Pynsist* run:
 369
 370    ./contrib/win32/run-pynsist.sh
 371
 372 This will generate an installer in `build/nsis/`.
 373
 374 ## WINDOWS HISTORY BROWSER CONFIGURATION UPGRADE
 375
 376 You may need to configure your history browser if you are upgrading from an
 377 older version of *git-cola*.
 378
 379 `gitk` was originally the default history browser, but `gitk` cannot be
 380 launched as-is on Windows because `gitk` is a shell script.
 381
 382 If you are configured to use `gitk`, then change your configuration to
 383 go through Git's `sh.exe` on Windows.  Similarly,we must go through
 384 `python.exe` if we want to use `git-dag`.
 385
 386 If you want to use *gitk* as your history browser open the
 387 *Preferences* screen and change the history browser command to:
 388
 389     "C:/Program Files/Git/bin/sh.exe" --login -i C:/Git/bin/gitk
 390
 391 *git-dag* became the default history browser on Windows in `v2.3`, so new
 392 users should not need to configure anything.