diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..5b0f6bd --- /dev/null +++ b/LICENSE @@ -0,0 +1,20 @@ +Copyright 2013 Mark Paschal + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..6cf1c82 --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +# pinboardzine # + +`pinboardzine` is a command line tool for converting unread bookmarks in Pinboard into a Kindle magazine for reading on your Kindle. + + +## Installation ## + +`pinboardzine` is a program for Python 3. + +Install `pinboardzine` as any other Python program: + + $ python setup.py install + +If you don't want to install its dependencies system-wide, try installing it in a [virtual environment](http://www.virtualenv.org/). + + +## Configuring ## + +`pinboardzine` uses the Readability Parser API to simplify HTML pages for Kindle viewing. Before you begin, [register a Readability API app](https://www.readability.com/developers/api) to get a Parser API token. + + +## Usage ## + +Once you have a Parser API token, run `pinboardzine`. + + $ pinboardzine markpasc pinboardzine.mobi --readability-token b5Ae2d340BCBa8773FaebE0db4FCE45AABe2a0b6 + Password for markpasc: + $ file pinboardzine.mobi + pinboardzine.mobi: Mobipocket E-book "Pinboard_Unread" + $ + +Once you have the `.mobi` file, send it to your Kindle as you would another book you have the file for, such as by copying it over USB, emailing it to your Kindle's `@free.kindle.com` email address, or using the [Send to Kindle desktop application](http://www.amazon.com/gp/sendtokindle). + +If you have Send to Kindle on the Mac, you can probably open it by `open`ing the `.mobi` file: + + $ open pinboardzine.mobi + +See `pinboardzine --help` for full help. + + +## Similar projects ## + +Do you use [Pocket](http://getpocket.com/) instead of Pinboard? Try [daily\_digest](https://github.com/miyagawa/daily_digest). diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..0461167 --- /dev/null +++ b/setup.py @@ -0,0 +1,21 @@ +from setuptools import setup + +setup( + name='pinboardzine', + version='1.0', + description='Publish unread bookmarks from Pinboard for Kindle', + py_modules=['pinboardzine'], + scripts=['bin/pinboardzine'], + + author='Mark Paschal', + author_email='markpasc@markpasc.org', + url='https://github.com/markpasc/pinboardzine', + classifiers=[ + 'Environment :: Console', + 'License :: OSI Approved :: MIT License', + 'Programming Language :: Python :: 3', + ], + + requires=['argh', 'arghlog', 'requests'], + install_requires=['argh', 'arghlog', 'requests'], +)