{ "info": { "author": "Kai Amann", "author_email": "kai.amann@fau.de", "bugtrack_url": null, "classifiers": [ "Intended Audience :: Developers", "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Programming Language :: Python :: 3" ], "description": "GF Kernel\n===========\n\n`gf_kernel` is a [GF](https://www.grammaticalframework.org/) kernel for [Jupyter](https://jupyter.org/).\n\nPrerequisites\n-------------\nIf you haven't installed GF already, get it from the official [download website](https://www.grammaticalframework.org/download/index.html).\n\n\nFor graph visualization GF uses [graphviz](http://www.graphviz.org/), so please make sure you have it installed:\n\n sudo apt install graphviz\n\nor under Mac OS X with [homebrew](https://brew.sh):\n\n brew install graphviz\n\nInstallation\n------------\n\nYou can either install the kernel from the source repository: \n\n git clone https://github.com/kwarc/gf_kernel\n cd gf_kernel\n pip install .\n\nor install it directly from pip:\n\n pip install gf-kernel\n\nAfterwards, install the kernel module with:\n\n python -m gf_kernel.install\n\n\nUsage\n-----\nYou're now ready to go and can start a Jupyter notebook with:\n\n jupyter notebook\n\nSelect the `gf_kernel` as kernel in your notebook.\nThe kernel supports all of the GF shell commands.\nOutput files produced by these commands will be placed into the current directory.\n\nThe kernel can also be used to define new grammars, which are immediately imported for usage upon defining.\nIf you would like to have line numbers for editing your code you can use the Juypter shortcut Esc+L to enable them. \n\nIn addition to the GF shell commands the kernel supports the following commands:\n- `view` : show the graph(s) generated by the specified GF shell command\n- `help` : shows the help message\n- `export` : saves the specified grammar in the current diretory\n- `clean` : removes all `.dot`, `.png` and `.gfo` files from the current directory\n\nPlease refer to the tutorial notebook to see how exactly they are used.\n\nThis package requires Python 3.\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/UniFormal/gf_kernel", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "gf-kernel", "package_url": "https://pypi.org/project/gf-kernel/", "platform": "", "project_url": "https://pypi.org/project/gf-kernel/", "project_urls": { "Homepage": "https://github.com/UniFormal/gf_kernel" }, "release_url": "https://pypi.org/project/gf-kernel/1.0.0/", "requires_dist": [ "ipykernel (>=5.1.0)", "ipython (>=7.2.0)", "ipywidgets (>=7.4.2)", "jupyter (>=1.0.0)", "jupyter-client (>=5.2.4)" ], "requires_python": "", "summary": "Simple example kernel for GF", "version": "1.0.0" }, "last_serial": 5016828, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "7f827c1b2c5e62672adc220400f6c483", "sha256": "103e2eb1c4e9ae1e9f9181530d133f77c815ff042dfa1a378b9f682322d1cd0f" }, "downloads": -1, "filename": "gf_kernel-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "7f827c1b2c5e62672adc220400f6c483", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 28470, "upload_time": "2019-04-01T12:18:38", "url": "https://files.pythonhosted.org/packages/34/8d/30b38eb76824cc000b2288b4c3a6c72a146955315347fe2d884fd9b45f95/gf_kernel-1.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "903d63d6fd0221bc4c1ef882446b0c38", "sha256": "a3e499580cb1b5c77a8e2078f2ba8a92db58af78d99c3b5d5a003be767a46145" }, "downloads": -1, "filename": "gf_kernel-1.0.0.tar.gz", "has_sig": false, "md5_digest": "903d63d6fd0221bc4c1ef882446b0c38", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15522, "upload_time": "2019-04-01T12:18:40", "url": "https://files.pythonhosted.org/packages/26/29/f221fa1da96bbd93180fed121f83e02230a579b12b48433d2bdf3e63fe1b/gf_kernel-1.0.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "7f827c1b2c5e62672adc220400f6c483", "sha256": "103e2eb1c4e9ae1e9f9181530d133f77c815ff042dfa1a378b9f682322d1cd0f" }, "downloads": -1, "filename": "gf_kernel-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "7f827c1b2c5e62672adc220400f6c483", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 28470, "upload_time": "2019-04-01T12:18:38", "url": "https://files.pythonhosted.org/packages/34/8d/30b38eb76824cc000b2288b4c3a6c72a146955315347fe2d884fd9b45f95/gf_kernel-1.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "903d63d6fd0221bc4c1ef882446b0c38", "sha256": "a3e499580cb1b5c77a8e2078f2ba8a92db58af78d99c3b5d5a003be767a46145" }, "downloads": -1, "filename": "gf_kernel-1.0.0.tar.gz", "has_sig": false, "md5_digest": "903d63d6fd0221bc4c1ef882446b0c38", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15522, "upload_time": "2019-04-01T12:18:40", "url": "https://files.pythonhosted.org/packages/26/29/f221fa1da96bbd93180fed121f83e02230a579b12b48433d2bdf3e63fe1b/gf_kernel-1.0.0.tar.gz" } ] }