Skip to main content

Sneaky-Reader 🤫

上班看书的幻影坦克 | Hide your book under a fancy terminal

👉 BOSS 👉

Features

History saving

Sneaky-reader implements a simple cache mechanism. You can use -l to list all the previous books, and use -b ID to quickly get the book. For example:

$ sneaky_reader -l
[0] CharlesDickens-OliverTwist
[1] 红楼梦
$ sneaky_reader -b0
...

Intuitive usage

Greate thanks to the wonderful projects: rich and textual, sneaky-reader can build a (relatively) complex UI in terminal with few lines:

  • You can press f to show/hide the chapters pane
  • You can press m, n to forward/backward the current chapter
  • You can press / to enable BOSS mode! It will hide all the sneaky things and only leave a fake Python snippet. You can pass -f <PYTHON FILE> to use your own fake code!

Smart spliting

Sneaky-reader supports you to use regluar expression (refer to the re module in python) to split your TXT into chapters. Using the command line option -e to pass your regluar expression.

Remember, always group your chapter name in first in your regular expression! group the title with (.*)

Quick Start

  • Via pip: pip install sneaky-reader
  • Via sources: clone and enter this repo, then install with pip install -e .. Then you have a shell command sneaky_reader to use!

For the demo books, you could start with commands

#demo in english
sneaky_reader -p="./assets/CharlesDickens-OliverTwist.txt" -e="^CHAPTER (.*)"

# demo in chinese
sneaky_reader -p="./assets/红楼梦.txt" -e="^第(.*)回"

For the first time you import a book, sneaky_reader will require the book path and the spliting expression. After that, the book will be cached and you can read it with command -b ID.

Release files for sneaky-reader 0.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sneaky-reader 0.1.2
File Size Uploaded
sneaky_reader-0.1.2.tar.gz 7.3 kB Details

Release files / sneaky_reader-0.1.2.tar.gz

Download URL sneaky_reader-0.1.2.tar.gz
Size 7.3 kB
Tags Source
SHA-256 checksum
How to use checksums
717dd8c648aeb6b707e6fc6e719ea7022d6d9b8c6eb21d28ced87cfc07841144
BLAKE2b-256 checksum
How to use checksums
d31bb251caefde5440f4d5b6b46e40f886e69499cff8a39b4a3e35c5d8d9930a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.10

Release history Release notifications | RSS feed

This release

0.1.2 This release

1 release file

0.1.1

1 release file

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page