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

Install via pip:

pip install booknotes

Then run the app:

booknotes

To install from source:

git clone https://github.com/bearenbey/book-notes.git
cd book-notes
pip install .

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.3.5.tar.gz (6.0 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.3.5-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for booknotes-0.3.5.tar.gz
Algorithm Hash digest
SHA256 583fa15b9ebbc8bb4cc40b45cfbfafd78149365ce1b93b2ea5a26498bc0f52ee
MD5 507b8f7b500de0b60dc69ecac241f6ab
BLAKE2b-256 8eb4433a9c4b62200400ec5e31f4f217e6c8e5d2c29eb8b53e90631ef0a643af

See more details on using hashes here.

File details

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

File metadata

  • Download URL: booknotes-0.3.5-py3-none-any.whl
  • Upload date:
  • Size: 6.5 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.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 b7fd1751a8a58a875922c009ea7bbf29f0239cb62935fde229d6649378f3eba9
MD5 e333da3caaa4fc61458f45a2daef4b00
BLAKE2b-256 be9247483d2476dfcb144d9acbf0ba6cf40b52fcfc23baabad3ec979d7028bde

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