{ "info": { "author": "Johannes Reinhardt", "author_email": "jreinhardt@ist-dein-freund.de", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 2.7" ], "description": "Handkerchief - a simple offline issue reader for GitHub Issues\n==============================================================\n\nThis script allows you to easily download the open issues of a GitHub\nRepository and store them in a offline browsable, single standalone html file.\n\nThe name\n--------\n\nI chose the name, because the obvious pun name \"tissues\" was already taken. It\nalso fits, because being offline is somewhat oldfashioned, just like the word\nhandkerchief.\n\nThere are three ways to set handkerchief up:\n\nUsing pip\n---------\n\nThis is the easiest way and probably the right choice for most people. Make\nsure you have `pip `_ installed and type\n\n.. code:: bash\n\n pip install handkerchief\n\ninto your terminal to install handkerchief and all dependencies onto your\ncomputer. This might require admin access.\n\nYou can now invoke handkerchief from everywhere using\n\n.. code:: bash\n\n handkerchief\n\nIn a virtualenv\n---------------\n\nIf a system wide installation with pip is too intrusive for you, and you need\nhandkerchief only in a certain environment, you can try\n`virtualenv `_. Within the activated\nvirtualenv, just type\n\n.. code:: bash\n\n pip install handkerchief\n\nYou can then invoke handkerchief while you are in the virtualenv by typing\n\n.. code:: bash\n\n handkerchief\n\nAs standalone script\n--------------------\n\nYou can take just the handkerchief.py from the repository and put it where you need it. No installation required. From there you can invoke it with\n\n.. code:: bash\n\n python handkerchief.py --remote-layouts\n\nFrom repository\n---------------\n\nYou can also clone the repository to some place on your computer and use it\nfrom there. Depending on your system, you might want to make it available from\neverywhere by putting the repo in your PATH, define an alias or something else.\n\nFor example, if you are on a mac you can optionally add the following to your\n~/.bash_profile.\n\n.. code:: bash\n\n function handkerchief {\n # change this path to the location of handkerchief.py\n hand=~/handkerchief/handkerchief.py\n if [[ $1 != \"\" ]] ; then\n python $hand --remote-layouts $1\n else\n repo=$(git remote -v | head -n1 | awk '{print $2}' | sed -e 's,.*:\\(.*/\\)\\?,,' -e 's/\\.git$//')\n if [[ $repo == *https://* ]] ; then\n python $hand ${repo#https://github.com/}\n elif [[ $repo == *git@github.com* ]] ; then\n python $hand ${repo#git@github.com:}\n else\n echo \"Provide parameter\"\n fi\n fi\n }\n\n\nSpecifying repositories\n-----------------------\n\nThe simplest way to use handkerchief is to call it with the user or\norganisation and repository name\n\n.. code:: bash\n\n handkerchief jreinhardt/tissues\n\nIf you are calling handkerchief from within a git repository, it tries to figure out a GitHub repo for it\n\n.. code:: bash\n\n cd /path/to/repository\n handkerchief\n\nOr if you have one or many .html files generated by handkerchief in a\ndirectory, it extracts the repositories to check from them.\n\n.. code:: bash\n\n cd /path/to/directory/with/handkerchief/htmls\n handkerchief\n\nCommandline parameters\n----------------------\n\nThere are a few options available, for example to choose a layout, specify how to authenticate (to avoid GitHubs rate limits) and much more.\n\nFor details see\n\n.. code:: bash\n\n handkerchief --help`.\n\n\nLayouts\n-------\n\nHandkerchief offers a simple way to modify the visual appearance and\nfunctionality of the resulting offline html file, by changing to a different layout.\n\nHandkerchief ships with a default layout that is available when installing with\npip. For developing layouts it is convenient to ask handkerchief to search for\nlayouts in a specific place using the `--layout-dir`. When using handkerchief\nas a standalone script, it can look layouts up at the handkerchief GitHub\nrepository using the `--remote-layouts` option.\n\nA layout consists of a parameter and a template file, and a number of\njavascript and css files, which reside in a subfolder of the layouts folder in\nthe handkerchief repository. To produce the output file, the template file gets\npopulated with the data, and the javascript and css files are inlined. If not\ntold otherwise, handkerchief will fetch layouts from the handkerchief GitHub\nrepository, so that always the most up to date version of the layout is used.\n\nThe parameter file is a json file with the same name as the subfolder in which\nit resides. It contains an associative array with three keys:\n\n* html: the file name of the template file\n* css: a list of filenames of stylesheets to inline\n* js: a list of filenames of javascript files to inline\n\nThe template is processed by `Jinja2 `_, and the\nfollowing variables are available:\n\n* reponame: a string with the name of the repository in the form\n username/reponame\n* repo: a dictionary containing information about the repository, see\n `GitHub API docs (1) `_\n* issues: a list of dictionaries containing issue data, see\n `GitHub API docs (2) `_. Each\n issue has an additional field:\n - 'labelnames' with a list of all labels for this issue\n\n - 'comments_list' with a list of all comments for this issue\n (see `GitHub API docs (3) `_).\n The comment data is augmented by a string in `comment['user']['avatar_class']`\n which contains a css class that sets the avatar of the user as background\n image of the element.\n\n - `issue['user']['avatar_class']` which works in the same way as in comments.\n* labels: a list of dictionaries containing label data, see\n `GitHub API docs (4) `_\n* milestones: a list of dictionaries containing milestone data, see\n `GitHub API docs (5) `_\n* assignees: a list of dictionaries contining information about assigness, see\n `GitHub API docs (6) `_\n* javascript: a list of dictionaries with the names and contents of the\n javascript files.\n* stylesheets: a list with the contents of the stylesheets. Additionally it\n contains a stylesheet that defines classes of the form `avatar_username` that\n set the avatar of a user as background image of an element.\n\nIf you have created a new layout or improved a existing one, feel free to open\na pull request, contributions are always welcome!\n\nDependencies\n------------\n\nRequires `Python 2.7 `_, the\n`Jinja2 template system `_ and the\n`requests library `_.\n\nFor most Linux distributions, these should be available via the package\nmanager. On MacOS you can install the dependencies by:\n\n.. code:: bash\n\n # using homebrew\n brew install python\n # using pip\n pip install -r requirements.txt\n\nFor Windows there is an installer for Python available from the\n`Python Website `_, and the rest can be\ninstalled via pip:\n\n.. code:: bash\n\n pip install -r requirements.txt\n\nContributors\n------------\n\nThere are a few people that contributed to handkerchief and therefore deserve to credit:\n\n* lukasoppermann turned the initial HTML template from horrible to beauti- and useful\n* laurentj contributed several small layout fixes\n* DonnchaC added code for authenticating by token\n* philfreo contributed a requirements.txt\n\n\nLicense\n-------\n\nHandkerchief is licensed under the `MIT license `_\n\n The MIT License (MIT)\n\n Copyright (c) 2013 Johannes Reinhardt \n\n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n\n The above copyright notice and this permission notice shall be included in\n all copies or substantial portions of the Software.\n\n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n THE SOFTWARE.", "description_content_type": null, "docs_url": null, "download_url": null, "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/jreinhardt/handkerchief", "keywords": "github,issues,offline", "license": "MIT", "maintainer": null, "maintainer_email": null, "name": "handkerchief", "package_url": "https://pypi.org/project/handkerchief/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/handkerchief/", "project_urls": { "Homepage": "https://github.com/jreinhardt/handkerchief" }, "release_url": "https://pypi.org/project/handkerchief/0.2/", "requires_dist": null, "requires_python": null, "summary": "simple offline issue reader for GitHub Issues", "version": "0.2" }, "last_serial": 2000036, "releases": { "0.2": [ { "comment_text": "", "digests": { "md5": "7f1b0729c3199dbb5a49a4b81cb4f45c", "sha256": "b949cbe2347270c3bca1ef459a0aa4816c1ddd5fef79a316a364e46112100ab6" }, "downloads": -1, "filename": "handkerchief-0.2-py2-none-any.whl", "has_sig": false, "md5_digest": "7f1b0729c3199dbb5a49a4b81cb4f45c", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 752648, "upload_time": "2016-03-10T19:31:42", "url": "https://files.pythonhosted.org/packages/51/14/0ca69ed7fb2d73ca9f662b4d593dec9c89f4b0ba335d01dba4eb1eaab8b6/handkerchief-0.2-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1ba00d457448529bb7d8d4fa95427857", "sha256": "6f20c38bacd20b784bbc67e6e79186974d65c4784e5d037dc1b7c18d615ad56e" }, "downloads": -1, "filename": "handkerchief-0.2.tar.gz", "has_sig": false, "md5_digest": "1ba00d457448529bb7d8d4fa95427857", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 748686, "upload_time": "2016-03-10T19:33:01", "url": "https://files.pythonhosted.org/packages/be/a6/9e7b219eef223dea085ff6f1eb64737b58a7d2d213ec8f8b6321d4a54c4a/handkerchief-0.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "7f1b0729c3199dbb5a49a4b81cb4f45c", "sha256": "b949cbe2347270c3bca1ef459a0aa4816c1ddd5fef79a316a364e46112100ab6" }, "downloads": -1, "filename": "handkerchief-0.2-py2-none-any.whl", "has_sig": false, "md5_digest": "7f1b0729c3199dbb5a49a4b81cb4f45c", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 752648, "upload_time": "2016-03-10T19:31:42", "url": "https://files.pythonhosted.org/packages/51/14/0ca69ed7fb2d73ca9f662b4d593dec9c89f4b0ba335d01dba4eb1eaab8b6/handkerchief-0.2-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1ba00d457448529bb7d8d4fa95427857", "sha256": "6f20c38bacd20b784bbc67e6e79186974d65c4784e5d037dc1b7c18d615ad56e" }, "downloads": -1, "filename": "handkerchief-0.2.tar.gz", "has_sig": false, "md5_digest": "1ba00d457448529bb7d8d4fa95427857", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 748686, "upload_time": "2016-03-10T19:33:01", "url": "https://files.pythonhosted.org/packages/be/a6/9e7b219eef223dea085ff6f1eb64737b58a7d2d213ec8f8b6321d4a54c4a/handkerchief-0.2.tar.gz" } ] }