Skip to main content

A CLI tool for managing Kindle clippings

Project description

Kindle Clippings CLI

Kindle Clippings CLI enables you to convert your Kindle Clippings from raw text file to another format.

Features

  • Written in Python.
  • No installation necessary - just use the binary.
  • Converts My Clippings.txt to formats:
    • .json
    • .xlsx
  • Easy to use.
  • Works on Windows, Mac and Linux.

Installation

Option 1: Binary

Kindle Clippings CLI is available for Windows, OSX (macOS) and Linux.

Download the latest binary from the Releases page.

Make sure to add the location of the binary to your $PATH.

Option 2: PyPi

Kindle Clippings CLI is available as a Python package in PyPi.

pip install clippings

Option 3: From source

To install Kindle Clippings CLI from source you need to have Python installed (version 12 at least).

  • Windows
git clone https://github.com/MateDawid/Kindle-Clippings-CLI.git
cd Kindle-Clippings-CLI
python -m venv venv
.\venv\Scripts\activate
python -m pip install -U pip setuptools
python -m pip install poetry
poetry install --without dev
  • OSX (macOS) and Linux
git clone https://github.com/MateDawid/Kindle-Clippings-CLI.git
cd Kindle-Clippings-CLI
python -m venv venv
source venv/bin/activate
python -m pip install -U pip setuptools
python -m pip install poetry
poetry install --without dev

Usage

Commands

convert  Convert Clippings file to one of supported formats.

Convert command options

Usage: clippings [OPTIONS] COMMAND [ARGS]...

Options:
  -i, --input_path    Path to Clippings file (full or relative).
  -o, --output_path   Path to output file (full or relative).
  -f, --format        Output format. [json|excel]  [required]

Converting My Clippings.txt to .json

  • My Clippings.txt and output in current directory
    clippings convert --format json
    
    clippings convert -f json
    
  • My Clippings.txt in other directory
    clippings convert -f json --input_path [PATH]/My Clippings.txt
    
    clippings convert -f json -i [PATH]/My Clippings.txt
    
  • Output in other directory
    clippings convert -f json --output_path [PATH]/My Clippings.json
    
    clippings convert -f json -o [PATH]/My Clippings.json
    

Converting My Clippings.txt to .xlsx

  • My Clippings.txt and output in current directory
    clippings convert --format excel
    
    clippings convert -f excel
    
  • My Clippings.txt in other directory
    clippings convert -f excel --input_path [PATH]/My Clippings.txt
    
    clippings convert -f excel -i [PATH]/My Clippings.txt
    
  • Output in other directory
    clippings convert -f excel --output_path [PATH]/My Clippings.xlsx
    
    clippings convert -f excel -o [PATH]/My Clippings.xlsx
    

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or feature requests.

Contact

Created by @matedawid - if you have any questions, just contact 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

clippings_cli-1.0.1.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

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

clippings_cli-1.0.1-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

Details for the file clippings_cli-1.0.1.tar.gz.

File metadata

  • Download URL: clippings_cli-1.0.1.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for clippings_cli-1.0.1.tar.gz
Algorithm Hash digest
SHA256 dcf7b4e306ef78bb7989891b2d4335f09c46212281d1be1d9d1a71cb29c69579
MD5 62ecd70e28f25e6387702cf41f7f7996
BLAKE2b-256 9f11031ad0772df45829100e0d27f3a2bc50a5652daecd040dbc706dccf8aa44

See more details on using hashes here.

File details

Details for the file clippings_cli-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: clippings_cli-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 9.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for clippings_cli-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 66ff66516e7acc284345c97b21f9d965265eb7d553b23203d984944ca193233a
MD5 2b688782d306b7ce85b6471b5d83d8c7
BLAKE2b-256 42211e71aee90d60f4215012bab3510c96c17f79abf85c590c41b44d1d82a78b

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