Metadata-Version: 2.1
Name: pykindler
Version: 0.3.2
Summary: Schedules conversion of e-books to mobi, mails it to your kindle
Home-page: https://github.com/VivekBits2210/pykindler
Author: Vivek Nayak
Author-email: viveknayak2210@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Intended Audience :: End Users/Desktop
Classifier: Environment :: Console
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX :: Linux
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Utilities
Requires-Dist: black (==21.6b0)
Requires-Dist: cffi (==1.14.5)
Requires-Dist: click (==8.0.1)
Requires-Dist: cryptography (==3.4.7)
Requires-Dist: importlib-metadata (==4.6.1)
Requires-Dist: jeepney (==0.6.0)
Requires-Dist: keyring (==23.0.1)
Requires-Dist: mypy-extensions (==0.4.3)
Requires-Dist: pathspec (==0.8.1)
Requires-Dist: pgi (==0.0.11.2)
Requires-Dist: pycparser (==2.20)
Requires-Dist: pyenchant (==3.2.1)
Requires-Dist: python-crontab (==2.5.1)
Requires-Dist: python-dateutil (==2.8.1)
Requires-Dist: regex (==2021.7.1)
Requires-Dist: SecretStorage (==3.3.1)
Requires-Dist: six (==1.16.0)
Requires-Dist: toml (==0.10.2)
Requires-Dist: zipp (==3.5.0)
Requires-Dist: m2r


pykindler
=========

Command line tool that automatically detects and converts downloaded e-books to mobi format (and auto-uploads to Kindle, on a schedule)

Where to get it
---------------

The source code is currently hosted on GitHub at:
https://github.com/VivekBits2210/pykindler

Package is deployed at `Python Package Index (PyPI) <https://pypi.org/project/pykindler/>`_

.. code-block:: sh

   pip3 install pykindler

Ensure Calibre is installed (\ `Guide <https://calibre-ebook.com/download_linux>`_\ )

.. code-block:: sh

   sudo -v && wget -nv -O- https://download.calibre-ebook.com/linux-installer.sh | sudo sh /dev/stdin

Know your Kindle's e-mail address `here <https://www.amazon.com/gp/sendtokindle/email>`_

Dependencies
------------


* UNIX based system needed (Linux, MacOS)
* Calibre
* `pyenchant - Offers an English Dictionary, helpful in detecting if a file is a book <https://pypi.org/project/pyenchant/>`_
* `python-crontab - Allows scheduling of pykindler jobs that auto-convert and email your books in the background <https://pypi.org/project/python-crontab/>`_
* `pgi - Auto-detects your downloads folder <https://pypi.org/project/pgi/>`_
* `black - Code formatter <https://pypi.org/project/black/>`_
* `argparse - Neater interface with command line arguments <https://pypi.org/project/argparse/>`_
* `keyring - Safe storage of email credentials <https://pypi.org/project/keyring/>`_

Usage
-----


* In default mode, pykindler will auto-detect your downloads folder and populate 'Converted_Books' and 'Processed_Books' folders
  .. code-block:: sh

     pykindler-run

* 
  In custom mode, specify your downloads folder and setup a twice-a-day conversion job

  .. code-block:: sh

     pykindler-run --folder /home/some-user/Desktop --job

* 
  If you just want to convert one file, specify it after --file

  .. code-block:: sh

     pykindler-run --file /home/some-user/Desktop/my-book.epub

* 
  If you want to not convert to mobi, choose your own extension with --ext

  .. code-block:: sh

     pykindler-run --file /home/some-user/Desktop/my-book.mobi --ext epub

* 
  For more help

  .. code-block:: sh

     pykindler-run -h

License
-------

`MIT <LICENSE>`_

Getting Help
------------

For usage questions, the best place to go to is `StackOverflow <https://stackoverflow.com/questions/>`_.

Contributing to pykindler
-------------------------

All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome.
Here is what I `plan to do next <https://docs.google.com/document/d/1ZjnNMVRCZE592LtXDs4G56BMRfQ9DBM9hKjtFrYV2w8/edit?usp=sharing>`_ 
Please feel free to mail ideas to the maintainer: [viveknayak2210@gmail.com]


