igna/catnote
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
28 Commits 1 Branch 0 Tags 18 MiB
Python 53.7%
HTML 46.3%
1b75c799e5
Go to file
Ignacio Rivero 1b75c799e5 Added a hackton of CSS just for a little checkbox
2025-06-24 15:21:58 -03:00
fonts/ubuntu Added Ubuntu font as default, with license 2025-06-24 14:24:23 -03:00
static Removed last vestiges of old name, removed unnecessary imports, added manifest.json 2025-06-22 01:53:37 -03:00
.gitignore Added some error handling for image uploads 2025-06-23 21:23:37 -03:00
app.py Added a hackton of CSS just for a little checkbox 2025-06-24 15:21:58 -03:00
COPYING Added readme, license 2025-06-23 18:30:56 -03:00
README.md Added Ubuntu font as default, with license 2025-06-24 14:24:23 -03:00
requirements.txt Added Banner Mode, updated requirements.txt (oops) 2025-06-24 02:58:28 -03:00

README.md

CatNote

CatNote is a minimalist web application that lets you generate Markdown-based receipts or notes, render them as PNGs, and send them directly to an MXW01 Cat Thermal Printer. Ideal for making quick, beautiful, and portable printed notes using Markdown, with optional image upload.

Note: The default UI is currently only available in Spanish, as this project began for my own use. Support for both English and Spanish is planned for a future release.

Features

  • Enter Markdown and preview output.
  • Supports bold, italic, headings, lists, images (by URL or upload), and dividers.
  • Upload a PNG/JPG image and embed it in your printout.
  • One-click print: output to Cat Printer or download the PNG.
  • Clean, mobile-friendly UI.

Requirements

  • Python 3.8+
  • Flask
  • Pillow (PIL)
  • bleh v1.0.0 or later (see below)

Installation

  1. Clone this repository

    git clone <your-catnote-repo-url>
cd catnote

  2. Install Python dependencies (instructions for a venv)

    pip install -r requirements.txt

  3. Obtain the bleh binary

    This app does not include the bleh printer driver binary for licensing reasons. You must build or download it yourself from git.netpaws.cc/igna/bleh.

    It's easiest to just get the latest release via wget:

    wget -O ./bleh https://git.netpaws.cc/igna/bleh/releases/download/latest/bleh

    Place the built bleh binary in the app root directory (next to app.py).

  4. Run CatNote

    python app.py [--port 1234]

    By default, it listens on port 5000. Access it via http://localhost:5000/.

    Warning: This application listens on your local network, don't expose its port to the Internet!

Usage

  • Paste or write your Markdown in the main text box.
  • (Optional) Upload an image to embed it.
  • Click Generar for a preview, or Imprimir to send to your Cat Printer.

License

This project is licensed under the terms of the GNU General Public License v3.0 or later. See COPYING for details.

The Ubuntu Font is licensed under the Ubuntu Font Licence 1.0. See UFL.txt for details.

Disclaimer: While a license was only added after the project’s initial commits, the current license applies retroactively to all previous commits of this repository.