Frogmouth
Frogmouth is a Markdown viewer / browser for your terminal, built with Textual.
Frogmouth can open *.md files locally or via a URL.
There is a familiar browser-like navigation stack, history, bookmarks, and table of contents.
🎬 Demonstration
A quick video tour of Frogmouth.
https://user-images.githubusercontent.com/554369/235305502-2699a70e-c9a6-495e-990e-67606d84bbfa.mp4
(thanks Screen Studio)
Screenshots
|
|
|
|
Compatibility
Frogmouth runs on Linux, macOS, and Windows. Frogmouth requires Python 3.8 or above.
Installing
The easiest way to install Frogmouth is with pipx (particularly if you aren't a Python developer).
pipx install frogmouth
You can also install Frogmouth with pip:
pip install frogmouth
Whichever method you use, you should have a frogmouth command on your path.
Running
Enter frogmouth at the prompt to run the app, optionally followed by a path to a Markdown file:
frogmouth README.md
You can navigate with the mouse or the keyboard. Use tab and shift+tab to navigate between the various controls on screen.
Features
You can load README files direct from GitHub repositories with the gh command.
Use the following syntax:
frogmouth gh textualize/textual
This also works with the address bar in the app. See the help (F1) in the app for details.
Follow this project
If this app interests you, you may want to join the Textual Discord server.
1 maintainer
Metadata
1 maintainer
Release files for frogmouth 0.9.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| frogmouth-0.9.2.tar.gz | 28.0 kB | Without provenance | Details for frogmouth-0.9.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| frogmouth-0.9.2-py3-none-any.whl | Python 3 | none | any | Details for frogmouth-0.9.2-py3-none-any.whl |
Total release size: 67.6 kB
Release files / frogmouth-0.9.2.tar.gz
| Download URL | frogmouth-0.9.2.tar.gz |
|---|---|
| Size | 28.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0e8724cff43f6fe50408595936281d4d4b65b14c456d26e7ba7c401428812f08
|
|
BLAKE2b-256 checksum How to use checksums |
752e747826187029cd9fae0761573d5ebf3566417b0bc4d8ed1caafa9bd8819f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.6.1 CPython/3.11.5 Darwin/23.0.0
|
Release files / frogmouth-0.9.2-py3-none-any.whl
| Download URL | frogmouth-0.9.2-py3-none-any.whl |
|---|---|
| Size | 39.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c56d4047653c02d3c4aef052aa226fc537272bfbd88c6627e1ee17b4c2510973
|
|
BLAKE2b-256 checksum How to use checksums |
e20a95a9cacac3a52742399fb4ece28e3d8c5c1d5a2c161dd548821350a0aec5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.6.1 CPython/3.11.5 Darwin/23.0.0
|
Security for frogmouth 0.9.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
