Metadata-Version: 2.0
Name: Pinku
Version: 0.1.1
Summary: Pinboard-to-Buku importation utility
Home-page: https://github.com/mosegontar/pinku
Author: Alexander M. Gontar
Author-email: mosegontar@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Dist: buku
Requires-Dist: pinboard


pinku
=====

``pinku`` is a `Pinboard <https://pinboard.in>`_-to-`Buku <https://github.com/jarun/Buku>`_ importation utility.

``pinku`` is **not** (at least at this time) a syncing utility and works in only one direction: to import bookmarks *from* Pinboard *into* Buku. If the URL already exists in Buku, the entry is skipped over.

Installation
------------
``pip install pinku``

Usage
-----
Ensure that you have set the ``PINBOARD_API_KEY`` environment variable to your Pinboard API token. You can find your API token `here <https://pinboard.in/settings/password>`_.

``pinku`` takes command-line arguments that serve as filters for searching through Pinboard bookmarks. ``pinku`` will then add the results to your Buku database.

Pinku supports all of the filter arguments for the Pinboard API ``/all`` endpoint. Please visit `Pinboard's API documentation <https://pinboard.in/api>`_ to read the details.

**Please note that Pinboard limits API calls to the /all endpoint to once every five minutes**

Examples
--------

Add *all* Pinboard bookmarks to Buku:

.. code-block::

    pinku

Add your 10 most recent Pinboard bookmarks to Buku:

.. code-block::

    pinku -r 10

Add all Pinboard bookmarks tagged ``web-dev`` and ``programming`` (max 3 tags per Pinboard API) to Buku:

.. code-block::

    pinku -t web-dev, programming

Add the first 3 Pinboard bookmarks tagged ``web-dev`` to Buku:

.. code-block::

    pinku -t web-dev -r 3

Add all Pinboard bookmarks since September 1, 2017 to Buku:

.. code-block::

    pinku --fromdt 2017-09-01

Add all bookmarks that were added to Pinboard between 7/1/2017 and 9/1/2017 to Buku:

.. code-block::

    pinku --fromdt 2017-09-01 --todt 2017-09-01



