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.2.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.2-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for clippings_cli-1.0.2.tar.gz
Algorithm Hash digest
SHA256 513714b22ca5c9ab33cef290a4edece31cc05d70666d40342ff865f506548ae6
MD5 e9dc2e92cbd665059c2b78675a7c7b55
BLAKE2b-256 5fa60af0201fedbb6d6297fc8020a9cffef49127c9159304f6714874daca063b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: clippings_cli-1.0.2-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.9

File hashes

Hashes for clippings_cli-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 bf4a33cce0134607cc2e201072e05ce87282db43e7156b7e61e52782b8c7f7f9
MD5 eab8922c8243b515ca561171da41eb72
BLAKE2b-256 b9c840a07129ef260684fb7960c2561084d41db112eb9ce0d5b41d5afe4408a3

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