Skip to main content

A terminal-based book note-taking app with tags and search

Project description

Book Note Repository

A terminal-based note-taking app for organizing your thoughts on books. Fast, keyboard-driven, and distraction-free, built with Python and curses.

Made for readers who prefer the terminal.


Features

  • Create and edit book entries
  • Take notes with line-wrapping
  • Tag books with multiple labels
  • Browse all tags and filter by tag
  • Search books or tags (case-insensitive)
  • Delete book entries
  • Keyboard-only UI
  • Saves data locally in books.json

How to Use

  • n: New book
  • Enter: Open note or select tag
  • Tab: Switch between books and tags
  • e: Edit tags
  • d: Delete book
  • /: Search
  • r: Reset filters
  • Ctrl+S: Save note
  • q: Quit

Installation

# Pip
pip install booknotes

# Oldschool
git clone https://github.com/bearenbey/book-notes.git
cd book-notes/book_notes
python cli.py

Data Storage

All notes and metadata are saved in a single books.json file in the project directory. You can back this up or sync it across devices if needed.


License

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see https://www.gnu.org/licenses/.

© 2025 Eren Öğrül termapp@pm.me

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

booknotes-0.2.5.tar.gz (5.7 kB view details)

Uploaded Source

Built Distribution

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

booknotes-0.2.5-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

Details for the file booknotes-0.2.5.tar.gz.

File metadata

  • Download URL: booknotes-0.2.5.tar.gz
  • Upload date:
  • Size: 5.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for booknotes-0.2.5.tar.gz
Algorithm Hash digest
SHA256 a4956f6e9fb50493722130690173d83d05141ea9ac330dc2a50ac59c487491ef
MD5 d47d9b70cb05387438fed3745c60efb0
BLAKE2b-256 a0a7e86680898fd854b9e2b20aee2155143671def546f99e251b8c123fff3a13

See more details on using hashes here.

File details

Details for the file booknotes-0.2.5-py3-none-any.whl.

File metadata

  • Download URL: booknotes-0.2.5-py3-none-any.whl
  • Upload date:
  • Size: 6.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for booknotes-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 4ca75c1543125719f2f2818aed855fb6769c745b13dd549556eac35edc48b60f
MD5 85ce6116225e7134fb3554de6443a8e9
BLAKE2b-256 be10578ddf0eb8635361305917c1ea5f2cfa2f57bd1dc65cc5f60a87f841451c

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