Skip to main content

Guake Terminal

Project description

travis-badge bountysource-badge

Introduction

Guake is a dropdown terminal made for the GNOME desktop environment. Guake’s style of window is based on an FPS game, and one of its goals is to be easy to reach.

Request Features

Please vote for feature on FeatHub <http://feathub.com/Guake/guake>. Open Issues on GitHub only for bug reports.

Most requested features list for Guake:

feathub-badge

Guake 3 Port

Guake has recently been ported Gtk3, thanks to the huge work of @aichingm. Old releases and code depending on GTK2 have been put on the 0.8.x branch and will no more be actively maintained.

Guake has also been ported to Python 3. It works well with Python 3.5 and it is recommended to use it with this version, since system dependencies might not work well on all systems with 3.6 (especially GTK3).

Dropped Features from Guake 0.8.x

  • --bgimg (this option has been removed from vte)

New Dependencies

  • libkeybinder3

Guake 3 Features

  • Lightweight

  • Simple Easy and Elegant

  • Smooth integration of terminal into GUI

  • Appears when you call and disappears once you are done by pressing a predefined hotkey (F12 by default)

  • Compiz transparency support

  • Multi tab

  • Plenty of color palettes

  • Quick Open in your favorite text editor with a click on a file name (with line number support)

  • Customizable hotkeys for tab access, reorganization, background transparency, font size,…

  • Extremely configurable

  • Configure Guake startup by running a bash script when Guake starts

  • Multi-monitor support (open on a specified monitor, open on mouse monitor)

  • Save terminal content to file

  • Open URL to your browser

Bugs? Information?

Source Code available at: https://github.com/Guake/guake/

Official Homepage: http://guake-project.org

Important note: Do NOT use the domain guake.org, it has been registered by someone outside the team. We cannot be held responsible for the content on that web site.

License

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

System-wide installation

Always prefere using your package manager to install guake.

Ubuntu users will use sudo apt install guake.

If you really want to install Guake from these sources, use:

$ make
$ sudo make install

To uninstall, still in the source directory:

$ make
$ sudo make uninstall

Note for maintainers

Guake has drastically changed its build system with Guake 3. You may need to adapt all the integration scripts accordingly.

Guake now uses Pipfile to store it Python dependencies (except the system dependencies such as PyGTK3). It is maintained and used by pipenv CLI tool. It is a system more advanced than using requirements.txt, but this file is still generated for backward compatibility (for example: ReadTheDocs only support requirements.txt for the moment), by a tool I’ve developed, named pipenv_to_requirements (makefile target make requirements). It does generate requirements.txt (running dependencies), and requirements-dev.txt (build, checks and test only). From then, Guake is now a classic, canon Python package (with setup.py, building distrubution packages, …).

It however requires system libraries, so cannot work isolated inside a virtualenv. If you look closer to the virtualenv used with make dev ; make run, you will see it is configured to use the system libraries using pew toggleglobalsitepackages.

If for any reason pipenv does not work on your platform, you can still install guake from these requirements file, but the ultimate source of truth for dependency declaration is the Pipfile.

Do not hesitate to contact me at gaetan [at] xeberon.net.

Contributing

Install System dependencies

Ubuntu

Execute the following command to bootstrap all needed system dependencies:

$ ./bootstrap-debian.sh

Setup development env

Install the dependencies of your system and use the following commands:

$ make dev
$ sudo make install-schemas  # still required even for local execution

Local execution of guake (without system-wide install):

$ make run

Git hook

Please install this git hook if you want to beautify your patch before submission:

$ make setup-githook

Validate your code

We are strict on code styling, with pep8 and pylint running automatically in travis in order to reject badly shaped patches. Please use the following command to validate all python files:

$ make style  # fix the style of python files
$ make check  # static code analysis
$ make test   # unit test campaign
$ make dists  # make distribution packages

Update translation

Update all translation files:

$ make update-po

Install the translations files:

$ sudo make install-locale

Then use your favorite po editor, such as poedit.

Update NEWS

Update the NEWS file using the followng command:

make release-note-news

The ChangeLog files is not maintained but instead automatically generated by PBR when building the distribution packages.

Same goes for the ChangeLog file.

Versionning

Versioning is automatically done using git tags. When a semver tag is pushed, a new version is automatically created by PBR.

Travis build

Travis automatically check pull requests are compiling and check for code style.

Status of the master branch: https://travis-ci.org/Guake/guake.png?branch=master

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

Guake-3.0.0.0b2.tar.gz (272.6 kB view details)

Uploaded Source

Built Distribution

Guake-3.0.0.0b2-py2.py3-none-any.whl (142.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file Guake-3.0.0.0b2.tar.gz.

File metadata

  • Download URL: Guake-3.0.0.0b2.tar.gz
  • Upload date:
  • Size: 272.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Guake-3.0.0.0b2.tar.gz
Algorithm Hash digest
SHA256 dbe93868c979779a4bf28562f2563a2a749530e778712a11d31cb874ffb86e42
MD5 72e12eb816ce300fa2d99eccaad2c575
BLAKE2b-256 136de9111b174f30f031b96e0c32ab659e73218e9c4c332e093c41c2273e8d79

See more details on using hashes here.

File details

Details for the file Guake-3.0.0.0b2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for Guake-3.0.0.0b2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1cdd70e58bb91a9b1eac2eedd745cfcfc1b8517d2ce2a051fe87f9746afebdd3
MD5 47b89004a30b2f49d11a4d7d2762109c
BLAKE2b-256 ef6d4c633b0a81f47561b3e6b9700ba568a59b4e42c9a33d779592fa64c0b144

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