mig5/bouquin
1
0
Fork 0
Code Issues Pull requests Releases 42 Wiki Activity Actions
Bouquin is a simple, opinionated notebook application written in Python, PyQt and SQLCipher. https://pypi.org/project/bouquin/
78 commits 3 branches 43 tags 6.7 MiB
Find a file
Miguel Jacq eac37d8843
DRY up some code
2025-11-10 10:25:46 +11:00
bouquin DRY up some code 2025-11-10 10:25:46 +11:00
tests DRY up some code 2025-11-10 10:25:46 +11:00
.gitignore Ignore .coverage 2025-11-04 18:16:11 +11:00
CHANGELOG.md DRY up some code 2025-11-10 10:25:46 +11:00
LICENSE Initial commit 2025-10-31 16:00:54 +11:00
poetry.lock convert to markdown (#1) 2025-11-08 00:30:46 -06:00
pyproject.toml Fix code backticks to not show but still be able to type code easily 2025-11-10 08:40:09 +11:00
README.md 0.2.1 with tabs 2025-11-09 16:19:51 +11:00
release.sh Fix release script 2025-11-07 17:04:21 +11:00
screenshot.png 0.2.1 with tabs 2025-11-09 16:19:51 +11:00
tests.sh Add option to automatically move yesterday's unchecked TODOs to today on startup 2025-11-06 15:45:31 +11:00

README.md

Bouquin

Introduction

Bouquin ("Book-ahn") is a simple, opinionated notebook application written in Python, PyQt and SQLCipher.

It uses SQLCipher bindings as a drop-in replacement for SQLite3. This means that the underlying database for the notebook is encrypted at rest.

To increase security, the SQLCipher key is requested when the app is opened, and is not written to disk unless the user configures it to be in the settings.

There is deliberately no network connectivity or syncing intended.

Screenshot

Screenshot of Bouquin

Features

  • Data is encrypted at rest
  • Encryption key is prompted for and never stored, unless user chooses to via Settings
  • Every 'page' is linked to the calendar day
  • All changes are version controlled, with ability to view/diff versions and revert
  • Text is Markdown with basic styling
  • Tabs are supported - right-click on a date from the calendar to open it in a new tab.
  • Images are supported
  • Search all pages, or find text on page (Ctrl+F)
  • Automatic periodic saving (or explicitly save)
  • Transparent integrity checking of the database when it opens
  • Automatic locking of the app after a period of inactivity (default 15 min)
  • Rekey the database (change the password)
  • Export the database to json, txt, html, csv, markdown or .sql (for sqlite3)
  • Backup the database to encrypted SQLCipher format (which can then be loaded back in to a Bouquin)
  • Dark and light themes
  • Automatically generate checkboxes when typing 'TODO'
  • Optionally automatically move unchecked checkboxes from yesterday to today, on startup

How to install

Make sure you have libxcb-cursor0 installed (it may be called something else on non-Debian distributions).

From PyPi/pip

  • pip install bouquin

From source

  • Clone this repo or download the tarball from the releases page
  • Ensure you have poetry installed
  • Run poetry install to install dependencies
  • Run poetry run bouquin to start the application.

From the releases page

  • Download the whl and run it

How to run the tests

  • Clone the repo
  • Ensure you have poetry installed
  • Run poetry install --with test
  • Run ./tests.sh