Skip to main content

Bouquin is a simple, opinionated notebook application written in Python, PyQt and SQLCipher.

Project description

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

Screenshot of Bouquin in dark mode

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
  • Images are supported
  • Search
  • 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

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

bouquin-0.2.0.1.tar.gz (47.8 kB view details)

Uploaded Source

Built Distribution

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

bouquin-0.2.0.1-py3-none-any.whl (52.8 kB view details)

Uploaded Python 3

File details

Details for the file bouquin-0.2.0.1.tar.gz.

File metadata

  • Download URL: bouquin-0.2.0.1.tar.gz
  • Upload date:
  • Size: 47.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.13.5 Linux/6.12.54-1.qubes.fc37.x86_64

File hashes

Hashes for bouquin-0.2.0.1.tar.gz
Algorithm Hash digest
SHA256 a44edd1e6a73a340c1f1f533eaf1f578cc06551a0922b0381c3e38897d6cb8e2
MD5 571169768db4aaf9686e6b002da7127f
BLAKE2b-256 9c17f2634fe325ab58167e3ccdd7f0e035f166e3baf354aa3a6fe56699ee0015

See more details on using hashes here.

File details

Details for the file bouquin-0.2.0.1-py3-none-any.whl.

File metadata

  • Download URL: bouquin-0.2.0.1-py3-none-any.whl
  • Upload date:
  • Size: 52.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.13.5 Linux/6.12.54-1.qubes.fc37.x86_64

File hashes

Hashes for bouquin-0.2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2e450df1921fd532811d0215ffb270d676ebb5d48ce0ef287b541443e6092360
MD5 56824ed73ff9e98ed98d0d867196cb88
BLAKE2b-256 6b94f61f9e67a3265b204520b8aed0d303c8e1b26e70d0e39bca53aadf78cd75

See more details on using hashes here.

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