Skip to main content

Do you remember www?

Project description

McRoss is a minimal and usable gemini:// browser written in python and tkinter, meaning it Just Works (tm) on any self-respecting desktop OS: Linux, Windows, Mac OS, and maybe the BSDs? Never tried one of those.

It currently looks like this:

Surfing plaintext and gemini content is already working well. The catch is it currently doesn't support downloading binary content and TOFU TLS verification. See feature checklist below for more details.

See my blog post for the rationale behind this project.

Installation

You need python 3.7 or higher. McRoss also uses idlelib which is supposed to be included in the standard library but some linux distros split it into a separate package which you'll need to install manually. I know at least Ubuntu and Void Linux do this.

pip install mcross
mcross

Better distribution methods to be explored later. Maybe it's finally time to try nuitka?

Usage

CLI arguments: --textfont, --monofont

Keyboard shortcuts:

  • Ctrl-l: jump to address bar.
  • Hold Alt to see possible button shortcuts underlined. This is what Qt calls Accelerator Keys.

Development

To get started:

pyenv install 3.7.7
pyenv virtualenv 3.7.7 mcross
pyenv activate
poetry install
mcross

# to publish, first bump version in pyproject.toml then
poetry publish --build

There are 2 McRoss-related mailing lists:

If you're not familiar with the mailing list workflow, check out git-send-email.io and mailing list etiquette. useplaintext.email also has useful plaintext setup tips for various email clients, though I don't necessarily agree with its "plaintext or nothing" stance.

Feature checklist

  • back-forward buttons
  • handle redirects
  • non-blocking I/O using curio
  • more visual indicators: waiting cursor, status bar
  • parse gemini's advanced line types
  • properly handle mime types (gemini/plaintext/binary)
  • configurable document styling
  • human-friendly distribution
  • TOFU TLS (right now it always accepts self-signed certs)

Long term high-level goals:

Easy for end users to install

If the words cargo build exists in the installation guide for your G U I application then I'm sorry it's not software made for people to use.

What-you-see-is-what-you-write

A rendered text/gemini viewport should preserve its original text content. This way once you've read a gemini page on the browser, you already know how to write one. No "View Source" necessary.

Responsive & pleasant to use

The Castor browser doesn't have visual indicators at all, for example, when clicking on a link it just appears to do nothing until the new page is completely loaded. That is A Bad Thing (tm).

Lightweight

In terms of both disk space & memory/cpu usage. The python/tkinter combo already puts us at a pretty good starting point.

Server bugs/surprises

Forces gemini:// in request

Spec says protocol part is optional, but if I omit that one the server will respond with 53 No proxying to other hosts!.

Newline

Spec says a newline should be \r\n but the server running gemini.circumlunar.space just uses \n every time.

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

mcross-0.5.14.tar.gz (14.3 kB view details)

Uploaded Source

Built Distribution

mcross-0.5.14-py3-none-any.whl (14.2 kB view details)

Uploaded Python 3

File details

Details for the file mcross-0.5.14.tar.gz.

File metadata

  • Download URL: mcross-0.5.14.tar.gz
  • Upload date:
  • Size: 14.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.5 CPython/3.8.3 Linux/5.6.15-arch1-1

File hashes

Hashes for mcross-0.5.14.tar.gz
Algorithm Hash digest
SHA256 b7d4af7dfe7a7af57fa3505e8231ca181c8d0798ac0a437de0b7fbd66873828b
MD5 45f026264affd16f5e09bcc8cae2f293
BLAKE2b-256 806de49d83e193479ad7c839d8c6b96b4d9bf860df29e755a8fbe19da3d2e969

See more details on using hashes here.

File details

Details for the file mcross-0.5.14-py3-none-any.whl.

File metadata

  • Download URL: mcross-0.5.14-py3-none-any.whl
  • Upload date:
  • Size: 14.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.5 CPython/3.8.3 Linux/5.6.15-arch1-1

File hashes

Hashes for mcross-0.5.14-py3-none-any.whl
Algorithm Hash digest
SHA256 3da28d04e17d025ed67a0b175ca8d022b45522435c942a490b6fba872d19888b
MD5 d299e309a826055711736b0231f9d4e4
BLAKE2b-256 e4da214a4e1678d0572b42fb20b1db07f80add5e4915e0203d0274fb3125b707

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