Skip to main content

A distraction-free terminal writing environment for Raspberry Pi

Project description

MicroJournal

MicroJournal turns a Raspberry Pi into a distraction-free terminal writing appliance.

It is built for headless use over SSH, so you do not need a GUI, a custom OS image, or any cloud account to get started.

If you want larger text, raise the font size in your terminal emulator and enable MicroJournal's large UI mode.

Install

uv tool install microjournal

If you want spaCy-powered NLP, install the optional NLP extra:

uv tool install "microjournal[nlp]"

If you want local voice dictation, install the optional voice extra:

uv tool install "microjournal[voice]"

The voice extra skips faster-whisper on Linux armv6l, because the upstream wheel stack is not available there.

Local development

uv run microjournal

Commands

  • microjournal launches the editor
  • microjournal setup runs first-time configuration
  • microjournal config edits settings
  • microjournal sync syncs notes
  • microjournal export exports notes
  • microjournal pack export writes a shareable visual pack JSON file
  • microjournal pack load applies a visual pack from a JSON file
  • microjournal doctor checks hardware and dependencies
  • microjournal dictate runs push-to-talk local speech-to-text

Storage

  • Notes are stored as Markdown in ~/MicroJournal/notes
  • Config is stored in ~/.config/microjournal/config.toml
  • Autosave is enabled by default and runs every 5 seconds

First run

  1. Run microjournal setup
  2. Choose your notes folder
  3. Pick the display mode, boot behavior, sync placeholder, theme, and large UI preference
  4. Launch microjournal

Editor shortcuts

  • Ctrl+S save
  • Ctrl+N new note
  • Ctrl+F search notes
  • Ctrl+P command palette
  • Ctrl+T theme maker
  • Ctrl+R view note stats
  • Ctrl+E export note stats
  • F8 toggle voice recording
  • Ctrl+Q quit

NLP stats

  • The footer shows live writing stats plus spaCy-powered NLP stats when the optional nlp extra is installed
  • Note stats export creates a companion *.ner.md file with entities and summary stats
  • If you install the optional nlp extra and the en_core_web_sm model is available, named-entity results are richer

Voice dictation

  • The prototype uses the optional voice extra with faster-whisper plus microphone capture, all locally
  • Dictated text is inserted into the editor at the cursor
  • Voice mode is push-to-talk: press Voice or F8 to start, then press it again to stop

Accessibility

  • Large UI mode increases spacing, sidebar width, and footer breathing room
  • The app does not force terminal font size; that is still controlled by your terminal emulator
  • Visual packs let you share a theme, palette, and display setup as a JSON file
  • Use the command palette to open the in-app Theme Maker, tweak a pack, and export it for sharing

Roadmap

  • Typing telemetry for sparklines and dashboards, focused on aggregated local writing data rather than raw keystrokes
  • More visual pack presets for cyberdeck-style builds
  • Better export/share flows for Reddit-ready screenshots and pack files

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

microjournal-0.1.3.tar.gz (26.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

microjournal-0.1.3-py3-none-any.whl (25.1 kB view details)

Uploaded Python 3

File details

Details for the file microjournal-0.1.3.tar.gz.

File metadata

  • Download URL: microjournal-0.1.3.tar.gz
  • Upload date:
  • Size: 26.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for microjournal-0.1.3.tar.gz
Algorithm Hash digest
SHA256 afdb72bca4cc4ef31eabd3323baea9d460b96ef3de36ee5927551d2c73d9fd5f
MD5 45816b716c6fa4765ac519da87105b93
BLAKE2b-256 9155deadb622d3317df361bdf6fde17f835fb09e71c23aef1e8d726d64b2d8bf

See more details on using hashes here.

Provenance

The following attestation bundles were made for microjournal-0.1.3.tar.gz:

Publisher: workflow.yml on elclaudioabierto/microjournal

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file microjournal-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: microjournal-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 25.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for microjournal-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f9726659f029c6aad1b17de871ba906d27b6193ee093ab909440b7791295de28
MD5 1295a101d51ddbdf4c26170eff6a51e1
BLAKE2b-256 36c2e047b5ed8a68f3727254cb43254caf426c8e9af5eb3699a9e6fdb7d9e810

See more details on using hashes here.

Provenance

The following attestation bundles were made for microjournal-0.1.3-py3-none-any.whl:

Publisher: workflow.yml on elclaudioabierto/microjournal

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page