_      _____  _    _           _ _      
                | |    / __  \| |  (_)         | | |     
 _ __  _   _ ___| |__  `' / /'| | ___ _ __   __| | | ___ 
| '_ \| | | / __| '_ \   / /  | |/ / | '_ \ / _` | |/ _ \
| |_) | |_| \__ \ | | |./ /___|   <| | | | | (_| | |  __/
| .__/ \__,_|___/_| |_|\_____/|_|\_\_|_| |_|\__,_|_|\___|
| |                                                      
|_|                                                      

INTRODUCTION

push2kindle is designed to push documents (.txt, .doc, .pdf, etc) to designated kindle. push2kindle is supported in all common platforms (windows, linux, macos).

PREREQUISITES

• python (python 2 and python 3 are both supported)
  It was installed by default for most Linux distribution and MAC.
  If not, please check https://www.python.org/downloads/ for installation instructions.

INSTALLATION

• Option 1: Install from download directory
  cd to the downloaded package root directory

  run python setup to install

   $python setup.py install

  MacOS or Linux users might need the sudo/root access to install. Users without the root access can install the package using the pip/easy_install with a --user parameter (install python libraries without root)．

   $sudo python setup.py install 

  use python3 instead of python in the above commands to install if using python3.

• Option 2: Install from Github:

  python 2:

   $sudo pip install --upgrade https://github.com/phoenixding/push2kindle/zipball/master

  python 3:

   $sudo pip3 install --upgrade https://github.com/phoenixding/push2kindle/zipball/master

  The above pip installation options should be working for Linux, Window and MacOS systems. For MacOS users, it's recommended to use python3 (pip3) installation.
  The default python2 (pip) in MacOS has some compatibility issues with a few dependent libraries.
  The users would have to install their own version of python2 (e.g. via Anocanda) if they prefer to use python2 in MacOS.

USAGE

push2kindle <file 1> <file 2> ...<file n>

Note: there is a 50MB limit by Amazon.

The users might need to setup a config file at the first run. The config file path will be given by the program.

config format: (tab-delimited)

fromaddr [email protected]
toaddr [email protected]
user username_for_fromaddr_email
password password_for_fromaddr_email
smtp smftp_server(if google, you can use sftp.google.com:587)

Note: please add your fromaddr email account into the "Approved Personal Document E-mail List" in your amazon kindle setting.

CREDITS

This software was developed by Jun Ding

LICENSE

This software is under MIT license.
see the LICENSE.txt file for details.

CONTACT

jund at cs.cmu.edu