{
    "info": {
        "author": "Sophie Au",
        "author_email": "some.person@web.de",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "# snipster\n> A simple cli snippet manager\n\n[![GitHub (pre-)release](https://img.shields.io/github/release/sophieau/snipster/all.svg)](https://github.com/sophieau/snipster/releases)\n[![PyPI](https://img.shields.io/pypi/v/snipster-py.svg)](https://pypi.python.org/pypi/snipster-py)\n![Python](https://img.shields.io/badge/python-v3.6-blue.svg)\n[![GitHub issues](https://img.shields.io/github/issues/sophieau/snipster.svg)](https://github.com/SophieAu/snipster/issues)\n[![license](https://img.shields.io/github/license/sophieau/snipster.svg)](https://github.com/SophieAu/snipster/blob/master/LICENSE)\n\n![](usage/snipster.gif)\n\nsnipster is a command line snippet manager allowing you to view, edit, create and copy snippets from your command line. It follows the Unix philosophy of \"do one thing and do it well\". \n\n[Installation](#installation) | [Setup](#setup) | [Usage](#usage) | [Troubleshooting](#troubleshooting) | [Other](#other) | [Credits](#credits)\n\n\n\n## Installation\n\nsnipster is available on [PyPI](https://pypi.python.org/pypi/snipster-py). This is the easiest way to install it. All dependencies will be installed automatically.\n\n```sh\npip3 install snipster-py\n```\n\nIf you want to install snipster from source, have a look [here](#install-from-source)\n\n\n## Setup\nWhen you first start up snipster, you should run\n```sh\nsnipster source\n```\nThis will create a ``.snipster`` directory in your home folder (if it does not already exist) and create an empty snippet list.\n\n\n\n## Usage\n\n```\nsnipster source\nsnipster list\nsnipster list [-t <tag>... | -l <language>... | -k <keyword>... ]...\nsnipster (-c|-e|-o) [-f] <snippet-id>\nsnipster -h | --help\nsnipster -v | --version\n```\n\n### Listing (And Filtering) All Snippets\n![](usage/list.gif)\n\nYou can filter by tag (``-t``), keyword in the title (``-k``) and language (``-l``). If the filters result in only one match, the match will be displayed directly (instead of a list with only one entry).\n\n\n### Creating/Editing A Snippet\n![](usage/create.png)\n\nWhen you create a snippet, an empty file will be created in ``~/.snipster`` and opened in your ``$EDITOR``. For this snippet to be read as valid, it needs to have yaml frontmatter and the actual snippet code needs to be marked as such. You do not need to have any attributes in the front matter but they are heavily encouraged. Valid attributes are ``tags``, ``lang``, ``title``.\n**An id is not necessary.** It will be automatically assigned by snipster when you source again.\n\n![](usage/samplesnippet.png)\n\nIn order for (changes to) a snippet to be recognized you need to ``snipster source`` after saving.\n\n\n### Viewing A Snippet\n![](usage/open.gif)\n\n\n### Copying A Snippet To The Clipboard\n![](usage/copy.png)\n\n\n## Troubleshooting\n\n#### Bug Reports and Feature Requests\nBug reports and feature requests are very much appreciated. Please contact me on Twitter ([@SolviAu](https://twitter.com/solviau)) or open an issue [here](https://github.com/SophieAu/snipster/issues/new).\n\n\n\n## Other\n\n#### Install From Source\nIf you do not want to use pip, you can \"install\" snipster by simply cloning the repo onto your local machine or downloading the latest release from [here](https://github.com/sophieau/snipster/releases)\n\n```sh\ngit clone https://github.com/SophieAu/snipster.git\n```\n\nThen, you need to add the file ``snipster`` to your path. the easiest way to do that is to symbolically link to it from the ``bin`` directory\n\n```sh\nln -s snipster/src/snipster ~/bin/\n```\n\nsnipster also needs a few dependencies to function properly. Make sure they are installed\n* [Pygments 2.2.0](http://pygments.org/) (for the syntax highlighting)\n* [pyperclip 1.6.0](https://github.com/asweigart/pyperclip) (to copy snippets to the clipboard)\n* [tabulate 0.8.2](https://bitbucket.org/astanin/python-tabulate) (to display the snippet list in a table)\n\n\n\n## Credits\nThis project was heavily inspired by [cheat](https://github.com/chrisallenlane/cheat), a command line cheat sheet viewer/creator\n\n---\n> [sophieau.github.io](https://sophieau.github.io) \u2013 Twitter [@SolviAu](https://twitter.com/solviau) \u2013 \u00a9 2018, [MIT Licence](LICENSE)\n\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/sophieau/snipster",
        "keywords": "snippet,snippets-manager,command-line-tool",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "snipster-py",
        "package_url": "https://pypi.org/project/snipster-py/",
        "platform": "",
        "project_url": "https://pypi.org/project/snipster-py/",
        "project_urls": {
            "Homepage": "https://github.com/sophieau/snipster"
        },
        "release_url": "https://pypi.org/project/snipster-py/1.0.3/",
        "requires_dist": [
            "Pygments (>=2.2.0)",
            "pyperclip (>=1.6.0)",
            "tabulate (>=0.8.2)"
        ],
        "requires_python": ">=3.6",
        "summary": "A simple command line snippet manager",
        "version": "1.0.3"
    },
    "last_serial": 3905576,
    "releases": {
        "1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "15cb695f22ad678ad1be706502e8df01",
                    "sha256": "d84db0528ab60a48cbb483105df98a862e9beef7dcec55a158912a9e63ab5f86"
                },
                "downloads": -1,
                "filename": "snipster_py-1.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "15cb695f22ad678ad1be706502e8df01",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.6",
                "size": 5742,
                "upload_time": "2017-12-30T16:55:29",
                "url": "https://files.pythonhosted.org/packages/70/5f/4bb35c051084dd1d5374eaa284dbfabbe8174fbc237ba9ecc0fd3798b506/snipster_py-1.0-py3-none-any.whl"
            }
        ],
        "1.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "9c8e1275d2ea150c8b64dcb4fafea366",
                    "sha256": "eca15b48e5f94377650b517d11197dffbb523e29bc78a6c6e49788108de8dfbb"
                },
                "downloads": -1,
                "filename": "snipster_py-1.0.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "9c8e1275d2ea150c8b64dcb4fafea366",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.6",
                "size": 5771,
                "upload_time": "2017-12-30T17:03:19",
                "url": "https://files.pythonhosted.org/packages/fb/f0/c7dac3cd94756d4d144e6f74178a976300de222ac611b56c2d78cb31103e/snipster_py-1.0.1-py3-none-any.whl"
            }
        ],
        "1.0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "4980632f442438ff063f77a8736538a3",
                    "sha256": "9cdfbe518fde3a1088f13046177d128e9e22556247c143ad91985bdc011550a5"
                },
                "downloads": -1,
                "filename": "snipster_py-1.0.2-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "4980632f442438ff063f77a8736538a3",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.6",
                "size": 5774,
                "upload_time": "2018-01-13T08:40:27",
                "url": "https://files.pythonhosted.org/packages/7c/6e/f2081a1cceff96428b2b6cb8cbd6b7c2f2d54e2aaed9ca27e43e508de057/snipster_py-1.0.2-py3-none-any.whl"
            }
        ],
        "1.0.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "34e76de61d37344f0daef10a79883743",
                    "sha256": "765b7c45520861f684a077a011a3d92bfb1fa6c28e8e57483c54514e75d4f8a7"
                },
                "downloads": -1,
                "filename": "snipster_py-1.0.3-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "34e76de61d37344f0daef10a79883743",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.6",
                "size": 7536,
                "upload_time": "2018-05-28T12:34:27",
                "url": "https://files.pythonhosted.org/packages/b9/27/f5f9985e999be11e5291b016eb8b7132a56f0bf8a5bee94570f86e7f8980/snipster_py-1.0.3-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "d18277b8a0af4ad4042dea1e08e06bdf",
                    "sha256": "fe96f543cf0c0b92f7a5c572647a03240a4106f9473f4c0e8cad5321cace8616"
                },
                "downloads": -1,
                "filename": "snipster-py-1.0.3.tar.gz",
                "has_sig": false,
                "md5_digest": "d18277b8a0af4ad4042dea1e08e06bdf",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.6",
                "size": 7048,
                "upload_time": "2018-05-28T12:34:29",
                "url": "https://files.pythonhosted.org/packages/2b/1f/d403fdddda228f96a057e87723b0cb4d4a0df2b1335b00f773d91139725e/snipster-py-1.0.3.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "34e76de61d37344f0daef10a79883743",
                "sha256": "765b7c45520861f684a077a011a3d92bfb1fa6c28e8e57483c54514e75d4f8a7"
            },
            "downloads": -1,
            "filename": "snipster_py-1.0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "34e76de61d37344f0daef10a79883743",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 7536,
            "upload_time": "2018-05-28T12:34:27",
            "url": "https://files.pythonhosted.org/packages/b9/27/f5f9985e999be11e5291b016eb8b7132a56f0bf8a5bee94570f86e7f8980/snipster_py-1.0.3-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "d18277b8a0af4ad4042dea1e08e06bdf",
                "sha256": "fe96f543cf0c0b92f7a5c572647a03240a4106f9473f4c0e8cad5321cace8616"
            },
            "downloads": -1,
            "filename": "snipster-py-1.0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "d18277b8a0af4ad4042dea1e08e06bdf",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 7048,
            "upload_time": "2018-05-28T12:34:29",
            "url": "https://files.pythonhosted.org/packages/2b/1f/d403fdddda228f96a057e87723b0cb4d4a0df2b1335b00f773d91139725e/snipster-py-1.0.3.tar.gz"
        }
    ]
}