Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nimish-ks/zippy
Open source CLI for Bionifying eBooks for the Kindle
https://github.com/nimish-ks/zippy
bionic-reading e-books kindle
Last synced: 7 days ago
JSON representation
Open source CLI for Bionifying eBooks for the Kindle
- Host: GitHub
- URL: https://github.com/nimish-ks/zippy
- Owner: nimish-ks
- License: gpl-3.0
- Created: 2024-05-19T04:42:00.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-05-20T09:23:13.000Z (6 months ago)
- Last Synced: 2024-05-21T07:34:42.675Z (6 months ago)
- Topics: bionic-reading, e-books, kindle
- Language: Python
- Homepage:
- Size: 215 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-repositories - nimish-ks/zippy - Open source CLI for Bionifying eBooks for the Kindle (Python)
README
# zippy - A CLI for Bionifying eBooks for the Kindle
`zippy` a simple python CLI for 'bionifying' eBooks. Bionification is a technique that bolds the initial letters of words to improve reading speed and comprehension. This tool specifically targets eBooks in the ePub format and is ideal for use with Kindle devices.
## Setup Instructions
### Step 1: Clone the Repository
```fish
git clone https://github.com/yourusername/zippy.git
cd zippy
```
### Step 2: Set Up a Python Virtual Environment
It is recommended to use a virtual environment to manage dependencies.
```fish
python -m venv venv
source venv/bin/activate # On Windows, use `venv\Scripts\activate`
```
### Step 3: Install Dependencies
Install the required Python packages using `pip`:
```fish
pip3 install -r requirements.txt
```
## Usage Instructions
To bionify an ePub eBook, use the following command:
```fish
python3 zippy.py [--algorithm ]
```
### Example
```fish
python3 zippy.py "Lying (Sam Harris).epub" "Lying (Sam Harris) Bionic.epub"
```
### Optional Algorithm Parameter
You can customize the bionification algorithm using the `--algorithm` parameter. The default algorithm is `"- 0 1 1 2 0.4"`. This parameter controls how many letters are bolded based on word length and other factors.
```fish
python zippy.py "Lying (Sam Harris).epub" "Lying (Sam Harris) Bionic.epub" --algorithm "- 0 1 1 2 0.4"
```
## Credits
This project is inspired by and uses parts of the code from [Bionify](https://github.com/Cveinnt/bionify) Chrome extension.