qutebrowser editorconfig travis-ci python

A keyboard-driven, vim-like browser based on PyQt5.

// If you are reading this in plaintext or on PyPi: // // A rendered version is available at: // https://github.com/qutebrowser/qutebrowser/blob/master/README.asciidoc

qutebrowser

// QUTE_WEB_HIDE image:icons/qutebrowser-64x64.png[qutebrowser logo] A keyboard-driven, vim-like browser based on PyQt5 and Qt.

image:https://img.shields.io/pypi/l/qutebrowser.svg?style=flat[“license badge”,link=”https://github.com/qutebrowser/qutebrowser/blob/master/COPYING”] image:https://img.shields.io/pypi/v/qutebrowser.svg?style=flat[“version badge”,link=”https://pypi.python.org/pypi/qutebrowser/”] image:https://requires.io/github/qutebrowser/qutebrowser/requirements.svg?branch=master[“requirements badge”,link=”https://requires.io/github/qutebrowser/qutebrowser/requirements/?branch=master”] image:https://travis-ci.org/qutebrowser/qutebrowser.svg?branch=master[“Build Status”, link=”https://travis-ci.org/qutebrowser/qutebrowser”] image:https://ci.appveyor.com/api/projects/status/5pyauww2k68bbow2/branch/master?svg=true[“AppVeyor build status”, link=”https://ci.appveyor.com/project/qutebrowser/qutebrowser”] image:https://codecov.io/github/qutebrowser/qutebrowser/coverage.svg?branch=master[“coverage badge”,link=”https://codecov.io/github/qutebrowser/qutebrowser?branch=master”]

link:https://www.qutebrowser.org[website] | link:https://blog.qutebrowser.org[blog] | link:https://github.com/qutebrowser/qutebrowser/releases[releases] // QUTE_WEB_HIDE_END

qutebrowser is a keyboard-focused browser with a minimal GUI. It’s based on Python and PyQt5 and free software, licensed under the GPL.

It was inspired by other browsers/addons like dwb and Vimperator/Pentadactyl.

Screenshots

image:doc/img/main.png[“screenshot 1”,width=300,link=“doc/img/main.png”] image:doc/img/downloads.png[“screenshot 2”,width=300,link=“doc/img/downloads.png”] image:doc/img/completion.png[“screenshot 3”,width=300,link=“doc/img/completion.png”] image:doc/img/hints.png[“screenshot 4”,width=300,link=“doc/img/hints.png”]

Downloads

See the https://github.com/qutebrowser/qutebrowser/releases[github releases page] for available downloads (currently a source archive, and standalone packages as well as MSI installers for Windows).

See link:INSTALL.asciidoc[INSTALL] for detailed instructions on how to get qutebrowser running for various platforms.

Documentation

In addition to the topics mentioned in this README, the following documents are available:

Getting help

You can get help in the IRC channel irc://irc.freenode.org/#qutebrowser[#qutebrowser] on http://freenode.net/[Freenode] (https://webchat.freenode.net/?channels=#qutebrowser[webchat]), or by writing a message to the https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser[mailinglist] at mailto:[email protected][].

There’s also a https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser-announce[announce-only mailinglist] at mailto:[email protected][] (the announcements also get sent to the general [email protected] list).

Contributions / Bugs

You want to contribute to qutebrowser? Awesome! Please read link:CONTRIBUTING.asciidoc[the contribution guidelines] for details and useful hints.

If you found a bug or have a feature request, you can report it in several ways:

For security bugs, please contact me directly at [email protected], GPG ID https://www.the-compiler.org/pubkey.asc[0xFD55A072].

Requirements

The following software and libraries are required to run qutebrowser:

The following libraries are optional and provide a better user experience:

To generate the documentation for the :help command, when using the git repository (rather than a release), http://asciidoc.org/[asciidoc] is needed.

On Windows, https://pypi.python.org/pypi/colorama/[colorama] is needed to display colored log output.

See link:INSTALL.asciidoc[INSTALL] for directions on how to install qutebrowser and its dependencies.

Donating

Working on qutebrowser is a very rewarding hobby, but like (nearly) all hobbies it also costs some money. Namely I have to pay for the server and domain, and do occasional hardware upgrades footnote:[It turned out a 160 GB SSD is rather small - the VMs and custom Qt builds I use for testing/developing qutebrowser need about 100 GB of space].

If you want to give me a beer or a pizza back, I’m trying to make it as easy as possible for you to do so. If some other way would be easier for you, please get in touch!

  • PayPal: [email protected]
  • Bitcoin: link:bitcoin:1PMzbcetAHfpxoXww8Bj5XqquHtVvMjJtE[1PMzbcetAHfpxoXww8Bj5XqquHtVvMjJtE]

Authors

Contributors, sorted by the number of commits in descending order:

// QUTE_AUTHORS_START * Florian Bruhin * Daniel Schadt * Ryan Roden-Corrent * Jan Verbeek * Jakub Klinkovský * Antoni Boucher * Lamar Pavel * Marshall Lochbaum * Bruno Oliveira * thuck * Martin Tournoij * Imran Sobir * Alexander Cogneau * Felix Van der Jeugt * Daniel Karbach * Kevin Velghe * Raphael Pierzina * Joel Torstensson * Patric Schmitz * Tarcisio Fedrizzi * Jay Kamat * Claude * Fritz Reichwald * Corentin Julé * meles5 * Philipp Hansch * Panagiotis Ktistakis * Artur Shaik * Nathan Isom * Thorsten Wißmann * Austin Anderson * Jimmy * Niklas Haas * Maciej Wołczyk * sandrosc * Alexey “Averrin” Nabrodov * pkill9 * nanjekyejoannah * avk * ZDarian * Milan Svoboda * John ShaggyTwoDope Jenkins * Clayton Craft * Peter Vilim * Jacob Sword * knaggita * Oliver Caldwell * Nikolay Amiantov * Julian Weigt * Tomasz Kramkowski * Sebastian Frysztak * Julie Engel * Jonas Schürmann * error800 * Michael Hoang * Liam BEGUIN * Daniel Fiser * skinnay * Zach-Button * Samuel Walladge * Peter Rice * Ismail S * Halfwit * David Vogt * Claire Cavanaugh * rikn00 * kanikaa1234 * haitaka * Nick Ginther * Michał Góral * Michael Ilsaas * Martin Zimmermann * Jussi Timperi * Cosmin Popescu * Brian Jackson * sbinix * rsteube * neeasade * jnphilipp * Yannis Rohloff * Tobias Patzl * Stefan Tatschner * Samuel Loury * Peter Michely * Panashe M. Fundira * Lucas Hoffmann * Link * Larry Hynes * Kirill A. Shutemov * Johannes Altmanninger * Jeremy Kaplan * Ismail * Edgar Hipp * Daryl Finlay * arza * adam * Samir Benmendil * Regina Hug * Penaz * Mathias Fussenegger * Marcelo Santos * Marcel Schilling * Joel Bradshaw * Jean-Louis Fuchs * Franz Fellner * Eric Drechsel * zwarag * xd1le * rmortens * oniondreams * issue * haxwithaxe * evan * dylan araps * caveman * addictedtoflames * Xitian9 * Vasilij Schneidermann * Tomas Orsava * Tom Janson * Tobias Werth * Tim Harder * Thiago Barroso Perrotta * Steve Peak * Sorokin Alexei * Simon Désaulniers * Rok Mandeljc * Noah Huesser * Moez Bouhlel * Matthias Lisin * Lazlow Carmichael * Kevin Wang * Ján Kobezda * Johannes Martinsson * Jean-Christophe Petkovich * Helen Sherwood-Taylor * HalosGhost * Gregor Pohl * Eivind Uggedal * Dietrich Daroch * Derek Sivers * Daniel Lu * Daniel Jakots * Arseniy Seroka * Anton Grensjö * Andy Balaam * Andreas Fischer * Amos Bird * Akselmo // QUTE_AUTHORS_END

The following people have contributed graphics:

Thanks / Similar projects

Many projects with a similar goal as qutebrowser exist:

Most of them were inspirations for qutebrowser in some way, thanks for that!

Thanks as well to the following projects and people for helping me with problems and helpful hints:

Also, thanks to:

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 3 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, see http://www.gnu.org/licenses/.

pdf.js

qutebrowser optionally uses https://github.com/mozilla/pdf.js/[pdf.js] to display PDF files in the browser. Windows releases come with a bundled pdf.js.

pdf.js is distributed under the terms of the Apache License. You can find a copy of the license in qutebrowser/3rdparty/pdfjs/LICENSE (in the Windows release or after running scripts/dev/update_3rdparty.py), or online http://www.apache.org/licenses/LICENSE-2.0.html[here].

Related Repositories

qutebrowser

qutebrowser

A keyboard-driven, vim-like browser based on PyQt5. ...

qutebrowser

qutebrowser

A keyboard-driven, vim-like browser based on PyQt5. ...

pinboard.zsh

pinboard.zsh

Save to Pinboard via ZSH script w/ Qutebrowser userscript support ...

instapaper.zsh

instapaper.zsh

Save to Instapaper via ZSH script w/ Qutebrowser userscript support ...


Top Contributors

The-Compiler rcorre Kingdread pyup-bot blyxxyz lahwaacz antoyo lamarpavel mlochbaum nicoddemus thuck imransobir acogneau HolySmoke86 NoctuaNivalis Carpetsmoker paretje jgkamat hackebrot oed flv0 hcraT phansch meles5 neeasade artur-shaik forkbong t-wissmann ProtractorNinja fiete201

Releases

-   v0.11.0 zip tar
-   v0.10.1 zip tar
-   v0.10.0 zip tar
-   v0.9.1 zip tar
-   v0.9.0 zip tar
-   v0.8.4 zip tar
-   v0.8.3 zip tar
-   v0.8.2 zip tar
-   v0.8.1 zip tar
-   v0.8.0 zip tar
-   v0.7.0 zip tar
-   v0.6.2 zip tar
-   v0.6.1 zip tar
-   v0.6.0 zip tar
-   v0.5.1 zip tar
-   v0.5.0 zip tar
-   v0.4.1 zip tar
-   v0.4.0 zip tar
-   v0.3.0 zip tar
-   v0.2.1 zip tar
-   v0.2.0 zip tar
-   v0.1.4 zip tar
-   v0.1.3 zip tar
-   v0.1.2 zip tar
-   v0.1.1 zip tar
-   v0.1 zip tar