qutebrowser / qutebrowser-hsr-sa

Student research project about qutebrowser at HSR Hochschule für Technik Rapperswil

qutebrowser

A keyboard-driven, vim-like browser based on Python and Qt.

website | blog | FAQ | contributing | releases | installing

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

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

qutebrowser’s primary maintainer, The-Compiler, is currently working part-time on qutebrowser, funded by donations. To sustain this for a long time, your help is needed! See the GitHub Sponsors page or alternative donation methods for more information. Depending on your sign-up date and how long you keep a certain level, you can get qutebrowser t-shirts, stickers and more!

Screenshots

Downloads

See the github releases page for available downloads and the INSTALL file for detailed instructions on how to get qutebrowser running on various platforms.

Documentation and getting help

Please see the help page for available documentation pages and support channels.

Contributions / Bugs

You want to contribute to qutebrowser? Awesome! Please read 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:

• Use the built-in :report command or the automatic crash dialog.

• Open an issue in the Github issue tracker.

• Write a mail to the mailinglist at [email protected].

Please report security bugs to [email protected] (or if GPG encryption is desired, contact [email protected] with GPG ID 0x916EB0C8FD55A072).

Alternatively, report a vulnerability via GitHub’s private reporting feature.

Requirements

The following software and libraries are required to run qutebrowser:

• Python 3.8 or newer

• Qt, either 6.2.0 or newer, or 5.15.0 or newer, with the following modules:

  • QtCore / qtbase

  • QtQuick (part of qtbase or qtdeclarative in some distributions)

  • QtSQL (part of qtbase in some distributions)

  • QtDBus (part of qtbase in some distributions; note that a connection to DBus at runtime is optional)

  • QtOpenGL

  • QtWebEngine (if using Qt 5, 5.15.2 or newer), or

  • alternatively QtWebKit (5.212) - This is not recommended due to known security issues in QtWebKit, you most likely want to use qutebrowser with the default QtWebEngine backend (based on Chromium) instead. Quoting the QtWebKit releases page: [The latest QtWebKit] release is based on [an] old WebKit revision with known unpatched vulnerabilities. Please use it carefully and avoid visiting untrusted websites and using it for transmission of sensitive data.

• PyQt 6.2.2 or newer (Qt 6) or 5.15.0 or newer (Qt 5)

• jinja2

• PyYAML

On Python 3.8, the following backport is also required:

• importlib_resources

On macOS, the following libraries are also required:

• pyobjc-core and pyobjc-framework-Cocoa

The following libraries are optional:

• adblock (for improved adblocking using ABP syntax)

• pygments for syntax highlighting with :view-source on QtWebKit, or when using :view-source --pygments with the (default) QtWebEngine backend.

• On Windows, colorama for colored log output.

• asciidoc to generate the documentation for the :help command, when using the git repository (rather than a release).

See the documentation for directions on how to install qutebrowser and its dependencies.

Donating

qutebrowser’s primary maintainer, The-Compiler, is currently working part-time on qutebrowser, funded by donations. To sustain this for a long time, your help is needed! See the GitHub Sponsors page for more information. Depending on your sign-up date and how long you keep a certain level, you can get qutebrowser t-shirts, stickers and more!

GitHub Sponsors allows for one-time donations (using the buttons next to "Select a tier") as well as custom amounts. For currencies other than Euro or Swiss Francs, this is the preferred donation method. GitHub uses Stripe to accept payment via credit cards without any fees. Billing via PayPal is available as well, with less fees than a direct PayPal transaction.

Alternatively, the following donation methods are available — note that eligibility for swag (shirts/stickers/etc.) is handled on a case-by-case basis for those, please get in touch for details.

• Liberapay, which can handle payments via Credit Card, SEPA bank transfers, or Paypal. Payment fees are paid by me, but they are relatively low.

• SEPA bank transfer inside Europe (no fees):

  • Account holder: Florian Bruhin

  • Country: Switzerland

  • IBAN (EUR): CH13 0900 0000 9160 4094 6

  • IBAN (other): CH80 0900 0000 8711 8587 3

  • Bank: PostFinance AG, Mingerstrasse 20, 3030 Bern, Switzerland (BIC: POFICHBEXXX)

  • If you need any other information: Contact me at [email protected].

  • If possible, please consider yearly or semi-yearly donations, because of the additional overhead from many individual transactions for bookkeeping/tax purposes.

• PayPal: CHF, EUR, USD. Note: Fees can be very high (around 5-40%, depending on the donated amounts) - consider using GitHub Sponsors (credit card), Liberapay (credit cards, PayPal, or bank transfer) or SEPA bank transfers instead.

• Cryptocurrencies:

  • Bitcoin: bc1q3ptyw8hxrcfz6ucfgmglphfvhqpy8xr6k25p00

  • Bitcoin Cash: 1BnxUbnJ5MrEPeh5nuUMx83tbiRAvqJV3N

  • Ethereum: 0x10c2425856F7a8799EBCaac4943026803b1089c6

  • Litecoin: MDt3YQciuCh6QyFmr8TiWNxB94PVzbnPm2

  • Others: Please get in touch, I’d happily set up anything supported by Ledger Live

Sponsors

Thanks a lot to MacStadium for supporting qutebrowser with a free hosted Mac Mini via their Open Source Project.

(They don’t require including this here - I’ve just been very happy with their offer, and without them, no macOS releases or tests would exist)

Thanks to the HSR Hochschule für Technik Rapperswil, which made it possible to work on qutebrowser extensions as a student research project.

Authors

qutebrowser’s primary author is Florian Bruhin (The Compiler), but qutebrowser wouldn’t be what it is without the help of hundreds of contributors!

Additionally, the following people have contributed graphics:

• Jad/yelo (new icon)

• WOFall (original icon)

• regines (key binding cheatsheet)

Also, thanks to everyone who contributed to one of qutebrowser’s crowdfunding campaigns!

Similar projects

Various projects with a similar goal like qutebrowser exist. Many of them were inspirations for qutebrowser in some way, thanks for that!

Active

• vimb (C, GTK+ with WebKit2)

• luakit (C/Lua, GTK+ with WebKit2)

• Nyxt browser (formerly "Next browser", Lisp, Emacs-like but also offers Vim bindings, QtWebEngine or GTK+/WebKit2 - note there was a critical remote code execution in 2019 which was handled quite badly)

• Vieb (JavaScript, Electron)

• surf (C, GTK+ with WebKit1/WebKit2)

• wyeb (C, GTK+ with WebKit2)

• Chrome/Chromium addons: Vimium

• Firefox addons (based on WebExtensions): Tridactyl, Vimium-FF

• Addons for Firefox and Chrome: Surfingkeys (somewhat sketchy…​), Link Hints (hinting only), Vimmatic

Inactive

• dwb (C, GTK+ with WebKit1, unmaintained - main inspiration for qutebrowser)

• webmacs (Python, Emacs-like with QtWebEngine, unmaintained)

• vimprobable (C, GTK+ with WebKit1)

• jumanji (C, GTK+ with WebKit1)

• conkeror (Javascript, Emacs-like, XULRunner/Gecko)

• uzbl (C, GTK+ with WebKit1/WebKit2)

• xombrero (C, GTK+ with WebKit1)

• Cream Browser (C, GTK+ with WebKit1)

• Firefox addons (not based on WebExtensions or no recent activity): Vimperator, Pentadactyl, VimFx (seems to offer a hack to run on modern Firefox releases), QuantumVim, Vim Vixen (ESR only), VVimpulation, Krabby

• Chrome/Chromium addons: ViChrome, Vrome, Saka Key (unmaintained), cVim, vb4c (fork of cVim, unmaintained), GleeBox

• Addons for Safari: Vimari

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 https://www.gnu.org/licenses/gpl-3.0.txt.

pdf.js

qutebrowser optionally uses 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 here.

qutebrowser-hsr-sa's Issues

Get rid of remaining contractions

Scaffold documentation

Return books

Add task definition

Write about type annotations / mypy

Fix issues from Management Summary proofreading

Write about time tracking results

Look at last feedback

• AnneMarie
• ninewise
• Marco

Document tools / methods

Update task definition

s/MyPy/mypy/g

Set up Sphinx

Decrease page borders

Finalize brochure abstract

Management summary / Brochure review

• ich habe sehr lange nicht verstanden, was mit "keyboard-driven" gemeint ist. Vllt in der Broschüre anders schreiben? "The qutebrowser project is a web browser, comparable to Google Chrome or Mozilla Firefox, which is focused on being keyboard-driven and having a minimal user interface." ändern zu: "The qutebrowser project is a web browser, comparable to Google Chrome or Mozilla Firefox. In contrast to traditional browsers, it can be used entirely with a keyboard only and has a minimal user interface."
• imho: "it is standing on the shoulders of giants" => "it stands on...". Deutschsprachige haben immer die tendenz, aus allem -ing-formen zu machen - feedback von O'Neill: leave it in the continous
• "it relies on the QtWebEngine project to so," => "it relies ... to do so"
• was meinst du mit "power-users"? Sind das Leute, die viel surfen oder Leute, die viel qutebrowser nutzen oder Leute, die Linux-savvy/hacker-savvy sind?
• "was to make qutebrowser extensible, by introducing a clearly" => kein Komma
• "Subsequently, functionality suitable for moving out of the core into extensions was identified." => musste es 2x lesen um zu verstehen, evtl. so flüssiger: "Subsequently, a functionality was identified that moves the core into extensions."
• "large parts of functionality" => large parts of its functionality"
• "(thus reducing the chance of accidental software defects)" würde ich auslagern: "In order to further follow best practices in the software development world, tools for checking data types were evaluated. This reduces the chance of accidental software defects in the future."

Release v1.6.0

Mention Y-approach

https://github.com/qutebrowser/qutebrowser-hsr-sa/wiki/Y-Approach

Update project kanban board

Write abstracts

See https://github.com/qutebrowser/qutebrowser-hsr-sa/blob/master/meetings/2018-09-20.md

• Management summary
• Brochure
• "scientific" abstract

Final checklist

• Make sure all issues are closed here
• Make sure no FIXMEs are remaining
• Review docs against S. Keller checklist
• Make sure last language feedback is incorporated
• Update time tracking if needed
• Make sure brochure text is accepted at https://abstract.hsr.ch/
• Print and proofread
• Review layout
  • Check LaTeX warnings such as over-/underfull hboxes (turn on draft mode)
  • Image resolution sufficient?
• Create archive folder:
  • Eigenständigkeitserklärung (unterschrieben)
  • Urheber- und Nutzungsrechte (unterschrieben)
  • Poster
  • Plain-Text abstract
  • PDF
  • Einverständniserklärung für Publikation (unterschrieben)
  • Brochure
  • Sitzungsprotokolle
  • Copy of qutebrowser/qutebrowser repo
  • Copy of qutebrowser/qutebrowser-hsr-sa repo
  • Aufgabenstellung
• Upload to https://archiv-i.hsr.ch/
  • ZIP archive of archive folder
  • Eigenständigkeitserklärung
  • Urheber- und Nutzungsrechte
  • Poster
  • Plain-Text abstract
  • PDF
  • Einverständniserklärung für Publikation
• USB stick with archive folder -> S. Keller
• Send PDF to ZKB for printing

Write about exposing existing APIs

Poster

Send to ZKB

Fix remaining FIXMEs

Add t-shirt-size labels to SA-relavant issues

Add Nutzungsrechte