{
"info": {
"author": "Marc Kirchner",
"author_email": "mail@marc-kirchner.de",
"bugtrack_url": null,
"classifiers": [
"Development Status :: 4 - Beta",
"Intended Audience :: Developers",
"License :: OSI Approved :: MIT License",
"Programming Language :: Python :: 2",
"Programming Language :: Python :: 2.6",
"Programming Language :: Python :: 2.7",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.3",
"Programming Language :: Python :: 3.4",
"Programming Language :: Python :: 3.5",
"Topic :: Software Development :: Build Tools"
],
"description": "# Pockyll\n\nPockyll is a python tool to create [Jekyll][j] linkposts from your\n[pocket][pocket] collections because automated linkpost updates are like death\nsticks.\n\n> \"You wanna buy some death sticks?\"
\n> \"You don't want to sell me death sticks.\"
\n> \"I don't wanna sell you death sticks.\"
\n> \"You want to go home an rethink your life.\"
\n> \"I want to go home and rethink my life.\"
\n> -- Elan Sleazebaggano & Obi-Wan Kenobi\n\n## Features\n\n* Pocket item/bookmark syncing that converts your saved & tagged pocket items\n into linkposts that merge seamlessly with standard Jekyll posts\n* Linkpost management fully compatible with tools like e.g.\n [octopress][octopress]\n* Incremental update support\n* Tag-specific syncing\n* Pocket OAuth authentication\n\n## Installation \n\n### Concept\nUsing pockyll to manage [pocket][pocket] bookmarks requires two pieces: the\n`pockyll` executable (which pulls your pocket bookmarks into your Jekyll site)\nand changes to your site setup (in order to enable Jekyll to deal with\nlinkposts properly).\n\n### Installing pockyll\n\nEither get the package from PyPi\n\n```bash\n$ pip install pockyll\n```\n\nor clone the repo and install manually\n\n```bash\n$ git clone https://github.com/mkirchner/pockyll.git\n$ cd pockyll\n$ python setup.py install\n```\n\n### Pockyll setup\n\n1. Login into [pocket][pocket_login], [create a new\n application][pocket_newapp] that has *retrieve* permissions.\n2. Switch into your Jekyll site directory\n3. Generate a a dummy config file `_pockyll.yml`. This can be accomplished\nusing\n\n $ pockyll init\n\n4. In `_pockyll.yml` enter the `pocket_consumer_key` created in step 1. \n Edit other fields as required.\n5. Authenticate the pockyll app against the pocket API\n\n $ pockyll auth \n\n This will open a browser window and ask for pocket authentication.\n\n### Site setup\n\nBy default, pockyll will define a variable `type` with the value `reference`\nin every linkpost. It will also and include the target link in the `ref`\nvariable inside the YAML post header:\n\n\t---\n\ttitle: \"Clojure, The Good Parts\"\n\tdate: 2016-04-19T23:05:26\n\ttype: \"reference\"\n\tref: https://rasterize.io/blog/clojure-the-good-parts.html\n\t---\n\nWriting code that differentiates between normal and linkposts is\ntherefore straightforward. You can simply use the post type as an indicator.\nHere is an example for a root directory `index.html` file that inserts the\nlink to the post for every normal post and the link to the reference for every\nlinkpost:\n\n```html\n\n
\n {% for post in site.posts %}\n {% if post.type == \"reference\" %}\n - \n {{ post.title }} \n {{ post.date | date_to_string }}
\n {% else %}\n - \n {{ post.title }} \n {{ post.date | date_to_string }}
\n {% endif %}\n {% endfor %}\n
\n