{ "info": { "author": "Bujar Murati", "author_email": "bmurati95@gmail.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "# Snyp\nSnyp is a command line utility that streamlines the process of creating text based documentation and programming tutorials in Markdown.\n\nSnyp extracts specified code snippets from a source file, formats them to enable syntax highlighting in Github Flavored Markdown and prefixes them with a comment exactly specifying where the snippet was extracted from, i.e.:\n\n\n ```python\n # snippet from example.py lines 1-2\n print('Hey there!')\n print('This is an example')\n ```\nWhich would be rendered like this:\n```python\n# snippet from example.py lines 1-2\nprint('Hey there!')\nprint('This is an example')\n```\n## Installation:\n```pip install snyp```\n\n## Usage: ```snyp --help```\n\n```bash\nUsage: snyp.py [OPTIONS] [LINES]...\n\n Use this tool to extract code snippets from a source file (src) and append\n them to a markdown file (dest) with proper Github Flavored Markdown\n formatting.\n\n You can use 0, 1 or 2 'lines' arguments:\n\n With 0 arguments, the entire source file will be extracted\n\n With 1 argument, the entire source file starting at lines[0] will be\n extracted\n\n With 2 arguments, lines lines[0] to lines[1] (inclusively) will be\n extracted from the source file\n\n Use snip --config to view and update the configuration\n\nOptions:\n -s, --src TEXT The source file from which to extract the code snippet\n -d, --dest TEXT The destination file to which to append the formatted\n snippet. \"-\" for stdout\n -l, --lang TEXT The language specific formatting to be applied to the code\n snippet\n -c, --config Edit the configuration, i.e. to change defaults, add\n languages, etc.\n --help Show this message and exit.\n```\n## Configuration ```snyp --config```\nThe above command will open Snyp's configuration file in your default editor. It's the easiest way to view and update the configuration.\n### Section [default]\n\n```ini\n# snippet from snyp.ini lines 1-5 \n[default]\ndefault = python\nsrc = snyp.py\ndest = README.md\n\n\n```\n+ default: the default language profile to use if -l, --lang is not provided\n+ src: relative path to the default source file if -s, --src is not provided\n+ dest: relative path to the default destination file if -d, --dest is not provided\n\n### Language sections: [python], etc.\n\n```ini\n# snippet from snyp.ini lines 16-19 \n[html]\nlang = html\ncommentStart = \n\n```\n+ lang: name of the language. Is used for the prefix that determines syntax highlighting\n+ commentStart: How a comment starts in *lang*\n+ commentEnd (optional): How a comment ends in *lang*", "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/BujarMurati/snyp", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "snyp", "package_url": "https://pypi.org/project/snyp/", "platform": "", "project_url": "https://pypi.org/project/snyp/", "project_urls": { "Homepage": "https://github.com/BujarMurati/snyp" }, "release_url": "https://pypi.org/project/snyp/0.1.9/", "requires_dist": null, "requires_python": "", "summary": "Snyp is a command line utility that streamlines the process of creating text based documentation and programming tutorials in Markdown.", "version": "0.1.9" }, "last_serial": 5967884, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "b1a46d52c85b356bd2d9878727e94e10", "sha256": "109d9e67c118e5c4b15cd234c1ed79cca9eda258b27e5e3552d24efa89a5562d" }, "downloads": -1, "filename": "snyp-0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "b1a46d52c85b356bd2d9878727e94e10", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4575, "upload_time": "2019-09-22T17:36:17", "url": "https://files.pythonhosted.org/packages/b8/f2/b5189e92d715bd1cbb92a37e78f1289b978514bd385c3359ba5e77d8f007/snyp-0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "2ea1c6bd603ab52bcbf88238dda81336", "sha256": "f1a89a39d855eec40082041d973fedab564a0055a784629d2172785b1b2c6101" }, "downloads": -1, "filename": "snyp-0.1.tar.gz", "has_sig": false, "md5_digest": "2ea1c6bd603ab52bcbf88238dda81336", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3299, "upload_time": "2019-09-22T17:36:20", "url": "https://files.pythonhosted.org/packages/e4/af/7245e8edfb1c2c6522277b5075ff0a4513521be27d4add15d170e6e273e0/snyp-0.1.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "039f0400b77fa63248436de0d774b9c9", "sha256": "e0c43c481a25630e4f2b6d75072cf9331c7f76ff0c58b672a19d083c155c69c1" }, "downloads": -1, "filename": "snyp-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "039f0400b77fa63248436de0d774b9c9", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4620, "upload_time": "2019-09-22T17:44:23", "url": "https://files.pythonhosted.org/packages/12/8c/710d5e50b905a1991e5e916d170411f71f2aab82b38eb57aaa74c08e13db/snyp-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "76e2b94f7e45644e59ca2c0974389849", "sha256": "832bf21dd211897233b15fc8f8c975412a1121dd792b50486873531eecfc9c5d" }, "downloads": -1, "filename": "snyp-0.1.1.tar.gz", "has_sig": false, "md5_digest": "76e2b94f7e45644e59ca2c0974389849", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3340, "upload_time": "2019-09-22T17:44:24", "url": "https://files.pythonhosted.org/packages/b8/2b/013caf3f557c779f2cc3e20e1d98017f06659544d32451fcc066283bc49e/snyp-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "1767ad1500096ba80b18dd029175478e", "sha256": "c4bb671cdcb8495baa2abbdc738a06e92bb64f53068bfe4ca57dc8d7a555580b" }, "downloads": -1, "filename": "snyp-0.1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "1767ad1500096ba80b18dd029175478e", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4621, "upload_time": "2019-09-22T18:04:39", "url": "https://files.pythonhosted.org/packages/ea/1d/4652c5f53b9b3bccf7039975bedcfc3bce177e3fa2f3beb7e3b7f1c78668/snyp-0.1.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0d9a22f749b3379c38e7cebdba838f51", "sha256": "bf30c6f1dd0c9e3d66a48096361ea9dddf185ff811a1d6529322949c51e80b26" }, "downloads": -1, "filename": "snyp-0.1.2.tar.gz", "has_sig": false, "md5_digest": "0d9a22f749b3379c38e7cebdba838f51", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3452, "upload_time": "2019-09-22T18:04:41", "url": "https://files.pythonhosted.org/packages/8e/9a/de8cf93aebc50e447ca5c28db5f29185b8f15004d92a949f443c57c1ee12/snyp-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "906bedd03692ccae7bef6c31b6b0681b", "sha256": "2bf94ee68ca85e1bb4ddb26199b6cbb7acca17e565a3945b57ec61ad60d5324a" }, "downloads": -1, "filename": "snyp-0.1.3-py3-none-any.whl", "has_sig": false, "md5_digest": "906bedd03692ccae7bef6c31b6b0681b", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4661, "upload_time": "2019-09-22T18:18:04", "url": "https://files.pythonhosted.org/packages/5c/22/57a29cfaa5f53d245252720e064af141a6624ae8e2b7d5db5f77dee20b1e/snyp-0.1.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b7f44aadf752ac4e7139174c5a152940", "sha256": "d2755367c821272a88839b826efd8850485e7d010171326f207356d72da10756" }, "downloads": -1, "filename": "snyp-0.1.3.tar.gz", "has_sig": false, "md5_digest": "b7f44aadf752ac4e7139174c5a152940", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3514, "upload_time": "2019-09-22T18:18:06", "url": "https://files.pythonhosted.org/packages/e9/04/e1613424971e3902d81eaf888f74e16d1968cf2d87a0ec108fff58a72468/snyp-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "206a1a66fa9648aafb730718bb89e0a9", "sha256": "34eeea1844080fb4fc1629e8a8b8a56cb7960af783444252c3368f200531fbf4" }, "downloads": -1, "filename": "snyp-0.1.4.tar.gz", "has_sig": false, "md5_digest": "206a1a66fa9648aafb730718bb89e0a9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2426, "upload_time": "2019-09-22T18:54:48", "url": "https://files.pythonhosted.org/packages/1c/6b/74af39b95ffa9fcd4b8c3ccc9e58ed1df3362585aad13816a29ba9aaaf27/snyp-0.1.4.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "c168ee7c80fa56f295499ff569208a83", "sha256": "73fe58eec5d8c6b46190e66f68d543abd249e51e50b370f6e2b44f3a6016e8fb" }, "downloads": -1, "filename": "snyp-0.1.5.tar.gz", "has_sig": false, "md5_digest": "c168ee7c80fa56f295499ff569208a83", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2414, "upload_time": "2019-09-22T18:59:08", "url": "https://files.pythonhosted.org/packages/31/db/1fa91f3ac68bab63a672f9114bdfcf8f0fa19b43b473eeb3f6719f79a063/snyp-0.1.5.tar.gz" } ], "0.1.6": [ { "comment_text": "", "digests": { "md5": "458ea29f720044c43e0c98932054cfe5", "sha256": "c8b27141475fb4806d6983c216a7af26648feb82a8a6019a5f794ae0f0ab774b" }, "downloads": -1, "filename": "snyp-0.1.6.tar.gz", "has_sig": false, "md5_digest": "458ea29f720044c43e0c98932054cfe5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3492, "upload_time": "2019-09-22T19:05:51", "url": "https://files.pythonhosted.org/packages/60/46/202ec803dd72590c605d203fd3c0e9ded2f83cd9cb2ea80a2d97f54ae4e8/snyp-0.1.6.tar.gz" } ], "0.1.7": [ { "comment_text": "", "digests": { "md5": "950fc2ea983ac976b816e8f02af03cf8", "sha256": "ff00345c6b4bb3e963d8082f0376edd946505a9761df4a357fe088337750b932" }, "downloads": -1, "filename": "snyp-0.1.7.tar.gz", "has_sig": false, "md5_digest": "950fc2ea983ac976b816e8f02af03cf8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3517, "upload_time": "2019-10-13T15:44:42", "url": "https://files.pythonhosted.org/packages/f2/24/9f759842e9e7f13a691d3c30b9be673e211b1a130cce890458e9c830889e/snyp-0.1.7.tar.gz" } ], "0.1.8": [ { "comment_text": "", "digests": { "md5": "e9ff21b4d2caf058c934c917382d7ed4", "sha256": "526be9239539e71b40c1e673d60f2c47da938720dea0c65958cf15cc73703492" }, "downloads": -1, "filename": "snyp-0.1.8.tar.gz", "has_sig": false, "md5_digest": "e9ff21b4d2caf058c934c917382d7ed4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3513, "upload_time": "2019-10-13T15:47:15", "url": "https://files.pythonhosted.org/packages/e5/79/f5e42430cab97a89a58616b159ccdeb64683b149a9c1cabf571847600c4b/snyp-0.1.8.tar.gz" } ], "0.1.9": [ { "comment_text": "", "digests": { "md5": "565909091daed408621fffa2d7bbb640", "sha256": "e650c01eea96d0f4044a88c719787e449e8815f275b25d95994239b59cfb92ae" }, "downloads": -1, "filename": "snyp-0.1.9.tar.gz", "has_sig": false, "md5_digest": "565909091daed408621fffa2d7bbb640", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3526, "upload_time": "2019-10-13T16:18:48", "url": "https://files.pythonhosted.org/packages/58/26/9e207a36ef44a0d084f9b96aad9f30607af044d383ee070f5e0cfb91d9b8/snyp-0.1.9.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "565909091daed408621fffa2d7bbb640", "sha256": "e650c01eea96d0f4044a88c719787e449e8815f275b25d95994239b59cfb92ae" }, "downloads": -1, "filename": "snyp-0.1.9.tar.gz", "has_sig": false, "md5_digest": "565909091daed408621fffa2d7bbb640", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3526, "upload_time": "2019-10-13T16:18:48", "url": "https://files.pythonhosted.org/packages/58/26/9e207a36ef44a0d084f9b96aad9f30607af044d383ee070f5e0cfb91d9b8/snyp-0.1.9.tar.gz" } ] }