TokySnatcher

https://rahaaatul.github.io/TokySnatcher/
Admin
TokySnatcher is a command-line tool for downloading audiobooks from TokyBook with intelligent...
Tokens:4,764
Snippets:106
Trust Score:9.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install Project Dependencies

Source: https://rahaaatul.github.io/TokySnatcher/contributing.html

Install the main project dependencies using pip or uv. The -e flag installs the package in editable mode.

```bash
pip install -e .
# or with uv (recommended)
uv pip install -e .
```

--------------------------------

### Install TokySnatcher from Source

Source: https://rahaaatul.github.io/TokySnatcher/guide/installation.html

Install the latest development version of TokySnatcher directly from its GitHub repository.

```bash
pip install git+https://github.com/rahaaatul/TokySnatcher.git
```

--------------------------------

### Quick Install TokySnatcher

Source: https://rahaaatul.github.io/TokySnatcher/guide/installation.html

Install TokySnatcher using pip, the recommended one-line method.

```bash
pip install tokysnatcher
```

--------------------------------

### Install and Initialize Pre-commit Hooks

Source: https://rahaaatul.github.io/TokySnatcher/contributing.html

Install the pre-commit package and set up pre-commit hooks for the repository to automate code quality checks before commits.

```bash
pip install pre-commit
pre-commit install
```

--------------------------------

### Preview Documentation Locally

Source: https://rahaaatul.github.io/TokySnatcher/contributing.html

Start a local development server to preview documentation changes built with VitePress.

```bash
npm run docs:dev
```

--------------------------------

### Install FFmpeg on Linux (Ubuntu/Debian)

Source: https://rahaaatul.github.io/TokySnatcher/guide/installation.html

Install FFmpeg on Ubuntu or Debian-based Linux distributions using apt.

```bash
sudo apt update && sudo apt install ffmpeg
```

--------------------------------

### Progress Display Example

Source: https://rahaaatul.github.io/TokySnatcher/guide/features.html

This example shows the real-time progress tracking for audiobook downloads, including chapter status, download speed, and file sizes. It uses visual indicators for different download states.

```text
🚀 Downloading audiobooks (5/12 chapters) 📝 🔄 Running: 1, ⏳ Ready: 4, ✅ Done: 6

⏳ Speed and Scale                                                 1/? Sweated... 2024
⏳ Building a Second Brain 2/? The Three Stages of Saving...        0MB / 15.2MB
✅ Speed and Scale 1/? The Problem with Scale...                   12.4MB / 12.4MB
✅ Building a Second Brain 1/? What is a Second Brain?...          8.9MB / 8.9MB
```

--------------------------------

### Install FFmpeg on Windows using Winget

Source: https://rahaaatul.github.io/TokySnatcher/guide/installation.html

Install FFmpeg on Windows using the Winget package manager.

```powershell
winget install ffmpeg
```

--------------------------------

### Install FFmpeg on Windows using Scoop

Source: https://rahaaatul.github.io/TokySnatcher/guide/installation.html

Install FFmpeg on Windows using the Scoop package manager.

```powershell
scoop install ffmpeg
```

--------------------------------

### Verify FFmpeg Installation

Source: https://rahaaatul.github.io/TokySnatcher/guide/installation.html

Confirm FFmpeg is installed and accessible by checking its version.

```bash
ffmpeg -version | head -1
# Output: ffmpeg version 6.1.1
```

--------------------------------

### Install Development Dependencies

Source: https://rahaaatul.github.io/TokySnatcher/contributing.html

Install development-specific dependencies, which typically include testing and linting tools.

```bash
pip install -e ".[dev]"
```

--------------------------------

### Install FFmpeg on macOS

Source: https://rahaaatul.github.io/TokySnatcher/guide/installation.html

Install FFmpeg using Homebrew on macOS.

```bash
brew install ffmpeg
```

--------------------------------

### Get TokySnatcher Version

Source: https://rahaaatul.github.io/TokySnatcher/contributing.html

Retrieve the currently installed version of TokySnatcher.

```bash
tokysnatcher --version
```

--------------------------------

### Install TokySnatcher using uv

Source: https://rahaaatul.github.io/TokySnatcher/guide/installation.html

Install TokySnatcher using uv, a modern Python package manager.

```bash
uv pip install tokysnatcher
```

--------------------------------

### Verify TokySnatcher Installation

Source: https://rahaaatul.github.io/TokySnatcher/guide/installation.html

Check if TokySnatcher is installed correctly by running the version command.

```bash
tokysnatcher --version
# Output: TokySnatcher v0.3.3
```

--------------------------------

### Install FFmpeg on Windows using Chocolatey

Source: https://rahaaatul.github.io/TokySnatcher/guide/installation.html

Install FFmpeg on Windows using the Chocolatey package manager.

```powershell
choco install ffmpeg
```

--------------------------------

### Example Output Directory Structure

Source: https://rahaaatul.github.io/TokySnatcher/guide/usage.html

Illustrates the typical folder and file structure created by TokySnatcher for downloaded audiobooks, including a main folder, numbered MP3 chapters, and cover art.

```text
Audiobooks/
└── Building a Second Brain/
    ├── 001_Introduction.mp3
    ├── 002_The_Three_Stages_of_Saving.mp3
    ├── 003_Collecting_What_Resonates.mp3
    └── cover.jpg
```

--------------------------------

### Direct URL Download

Source: https://rahaaatul.github.io/TokySnatcher/api/cli.html

Specify a direct URL to a book to bypass search and start the download immediately.

```bash
tokysnatcher --url "https://tokybook.com/book/some-book-url"
```

--------------------------------

### Check FFmpeg Version

Source: https://rahaaatul.github.io/TokySnatcher/guide/installation.html

Verify that FFmpeg is installed and accessible.

```bash
ffmpeg -version
```

--------------------------------

### Check Python Version

Source: https://rahaaatul.github.io/TokySnatcher/guide/installation.html

Verify that Python 3.9 or higher is installed on your system.

```bash
python --version
```

--------------------------------

### Run TokySnatcher Interactively

Source: https://rahaaatul.github.io/TokySnatcher/guide/usage.html

Execute TokySnatcher without any arguments to enter interactive mode. This mode guides you through the download process step-by-step.

```bash
tokysnatcher
```

```bash
toky
```

--------------------------------

### Lint Code with Flake8

Source: https://rahaaatul.github.io/TokySnatcher/contributing.html

Check the Python code in the tokysnatcher directory for style guide violations using Flake8.

```bash
flake8 tokysnatcher/
```

--------------------------------

### Build Documentation

Source: https://rahaaatul.github.io/TokySnatcher/contributing.html

Build the static documentation files for deployment.

```bash
npm run docs:build
```

--------------------------------

### Display Command Help

Source: https://rahaaatul.github.io/TokySnatcher/guide/usage.html

Run TokySnatcher with the --help flag to view all available command-line options and their descriptions. This is helpful for understanding the full range of functionalities.

```bash
tokysnatcher --help
```

--------------------------------

### Basic CLI Syntax

Source: https://rahaaatul.github.io/TokySnatcher/api/cli.html

Use either 'tokysnatcher' or 'toky' followed by options to interact with the tool.

```bash
tokysnatcher [OPTIONS]
# or
toky [OPTIONS]
```

--------------------------------

### Combine Search and Directory Options

Source: https://rahaaatul.github.io/TokySnatcher/api/cli.html

Combine search queries with custom download directories for efficient, targeted downloads.

```bash
tokysnatcher --search "productivity" --directory "~/Downloads/Audiobooks"
```

--------------------------------

### Combine Search and Directory Options

Source: https://rahaaatul.github.io/TokySnatcher/guide/usage.html

Combine the --search and --directory flags to automate the process of finding and downloading an audiobook to a specific location.

```bash
tokysnatcher --search "science fiction" --directory "~/Audiobooks/"
```

--------------------------------

### Direct Download from URL

Source: https://rahaaatul.github.io/TokySnatcher/guide/usage.html

Use the --url flag to download a specific audiobook directly from its TokyBook URL. Ensure the URL is correctly formatted.

```bash
tokysnatcher --url "https://tokybook.com/book/your-book-url"
```

--------------------------------

### Scripted Batch Downloads

Source: https://rahaaatul.github.io/TokySnatcher/api/cli.html

Automate the download of multiple books by iterating through a list and using the CLI with search and directory options.

```bash
#!/bin/bash
# Download multiple books
BOOKS=("book1" "book2" "book3")
for book in "${BOOKS[@]}"; do
    tokysnatcher --search "$book" --directory "~/Audiobooks"
done
```

--------------------------------

### Run Tests with Coverage

Source: https://rahaaatul.github.io/TokySnatcher/contributing.html

Run the test suite and generate a code coverage report for the tokysnatcher package.

```bash
pytest --cov=tokysnatcher
```

--------------------------------

### Search and Download (Non-Interactive)

Source: https://rahaaatul.github.io/TokySnatcher/api/cli.html

Provide a search query directly to find and download books without using the interactive menu.

```bash
tokysnatcher --search "building a second brain"
```

--------------------------------

### Specify Custom Download Directory

Source: https://rahaaatul.github.io/TokySnatcher/guide/usage.html

Use the --directory flag to set a custom path for saving downloaded audiobooks. This is useful for organizing your collection.

```bash
tokysnatcher --directory "/path/to/your/audiobooks"
```

--------------------------------

### Search and Download by Title

Source: https://rahaaatul.github.io/TokySnatcher/guide/usage.html

Utilize the --search flag to find and download an audiobook by its title without interactive prompts. The tool will search for the provided title and initiate the download.

```bash
tokysnatcher --search "book title"
```

--------------------------------

### Run TokySnatcher

Source: https://rahaaatul.github.io/TokySnatcher/guide/installation.html

Execute TokySnatcher from the command line using its full name or short alias.

```bash
# Basic usage
tokysnatcher

# Or use the short alias
toky
```

--------------------------------

### Specify Custom Download Directory

Source: https://rahaaatul.github.io/TokySnatcher/api/cli.html

Use the --directory option to set a custom path for downloaded files, applicable in both interactive and non-interactive modes.

```bash
# With interactive mode
tokysnatcher --directory "/path/to/audiobooks"

# With direct download
tokysnatcher --search "science fiction" --directory "~/Audiobooks/"
```

--------------------------------

### Clone TokySnatcher Repository

Source: https://rahaaatul.github.io/TokySnatcher/contributing.html

Clone the TokySnatcher repository and navigate into the project directory.

```bash
git clone https://github.com/rahaaatul/TokySnatcher.git
cd TokySnatcher
```

--------------------------------

### Run Specific Test File

Source: https://rahaaatul.github.io/TokySnatcher/contributing.html

Execute tests from a specific file within the tests directory.

```bash
pytest tests/test_specific.py
```

--------------------------------

### Run TokySnatcher Tests

Source: https://rahaaatul.github.io/TokySnatcher/contributing.html

Execute the project's test suite using pytest. This is crucial for ensuring code quality and verifying changes.

```bash
python -m pytest
```

--------------------------------

### Format Code with Black

Source: https://rahaaatul.github.io/TokySnatcher/contributing.html

Format Python code in the tokysnatcher directory according to Black's style conventions.

```bash
black tokysnatcher/
```

--------------------------------

### Sort Imports with isort

Source: https://rahaaatul.github.io/TokySnatcher/contributing.html

Sort Python imports alphabetically and by section within the tokysnatcher directory.

```bash
isort tokysnatcher/
```

--------------------------------

### Type Check with Mypy

Source: https://rahaaatul.github.io/TokySnatcher/contributing.html

Perform static type checking on the Python code in the tokysnatcher directory using Mypy.

```bash
mypy tokysnatcher/
```
Tokens:
Raw