{ "info": { "author": "Gustavo Bezerra", "author_email": "gusutabopb@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "Intended Audience :: Science/Research", "Intended Audience :: System Administrators", "Programming Language :: Python :: 3.6", "Topic :: System :: Shells" ], "description": "imongo\n======\n\nA MongoDB kernel for Jupyter. Mainly for educational purposes.\n\nThis kernel wraps the Mongo shell using pexpect_ and was inspired by\n`bash_kernel`_ and `ipython_mysql_kernel`_.\nIt uses Renderjson_ for JSON pretty-printing.\n\n.. _pexpect: https://github.com/pexpect/pexpect\n.. _`bash_kernel`: https://github.com/takluyver/bash_kernel\n.. _`ipython_mysql_kernel`: https://github.com/mmisono/ipython_mysql_kernel\n.. _Renderjson: https://github.com/caldwell/renderjson\n\n\n.. figure:: screenshot.png\n :alt: IMongo in action\n\n IMongo in action\n\nHow to install\n--------------\n\nMajor requirements\n~~~~~~~~~~~~~~~~~~\n\nIMongo requires Jupyter_ and MongoDB_.\n\n.. _Jupyter: http://jupyter.org\n.. _MongoDB: https://www.mongodb.com\n\nInstall MongoDB\n^^^^^^^^^^^^^^^\n\nOn macOS, use Homebrew_: ``brew install mongodb``\n\nFor other platforms, please refer to the MongoDB documentation_\n\n.. _Homebrew: http://brew.sh/\n.. _documentation: https://docs.mongodb.com/manual/installation/\n\nInstall Jupyter and IMongo Kernel using ``pip``\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nTo install Jupyter, IMongo and all other dependencies, use ``pip install``:\n\n.. code:: bash\n\n $ pip install imongo-kernel\n\nInstall Jupyter and IMongo Kernel using ``conda``\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nAlthough the installation with ``pip`` works fine , we recommend using the\n``conda`` package manager to create a virtual environment. You need to have\neither Anaconda_ or Miniconda_ installed.\n\n.. code:: bash\n\n $ conda create -n imongo jupyter \"python>3.6\"\n $ source activate imongo\n $ pip install imongo-kernel\n\nBoth methods install the ``imongo`` package and configure Jupyter to be\nused with the new kernel by installing a `kernel spec`_.\n\n.. _Anaconda: https://www.anaconda.com/download\n.. _Miniconda: https://conda.io/miniconda.html\n.. _`kernel spec`: https://jupyter-client.readthedocs.io/en/latest/kernels.html#kernel-specs\n\n\nConfiguration (optional)\n^^^^^^^^^^^^^^^^^^^^^^^^\nMongoDB configuration such as host/port can be passed as a YAML file,\nlocated at the Jupyter `configuration directory`_.\nThe default path for UNIX systems is ``~/.jupyter/imongo_config.yml``.\nThe options available are the same as the ones available for the |mongo|_ CLI tool.\nThis configuration is necessary in case your MongoDB instance has authentication enabled,\nruns at a non-standard port, or runs on a remote (non-localhost) location.\n\n.. _`configuration directory`: http://jupyter.readthedocs.io/en/latest/projects/jupyter-directories.html#configuration-files\n.. |mongo| replace:: ``mongo``\n.. _mongo: https://docs.mongodb.com/manual/reference/program/mongo\n\nSample ``imongo_config.yml``:\n\n.. code:: yaml\n\n host: some.host.io\n port: 27017\n username: username\n password: password\n authenticationDatabase: admin\n quiet: null\n\nIf ``imongo_config.yml`` doesn't exist or is empty, IMongo will attempt\nto connect to the MongoDB instance at ``localhost:27017``, without any\nuser authentication.\n\nUninstall:\n----------\n\n.. code:: bash\n\n # Remove library: \n $ pip uninstall imongo\n # Remove kernel spec\n $ jupyter kernelspec remove imongo\n\n--------------\n\nTODO:\n-----\n\n- Implement code completion functionality\n- Fix long command issue\n- Send Mongo shell Javascript errors/exceptions to stderr\n\n\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/gusutabopb/imongo", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "imongo-kernel", "package_url": "https://pypi.org/project/imongo-kernel/", "platform": "", "project_url": "https://pypi.org/project/imongo-kernel/", "project_urls": { "Homepage": "https://github.com/gusutabopb/imongo" }, "release_url": "https://pypi.org/project/imongo-kernel/0.1.0/", "requires_dist": [ "ipykernel", "jupyter (>=1.0.0)", "pexpect (>=4.2.1)", "pyyaml" ], "requires_python": "", "summary": "A MongoDB kernel for Jupyter", "version": "0.1.0" }, "last_serial": 3224570, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "8cafb1df1ec8cc059fe923c1c4bdd24c", "sha256": "f6f2322a19a084a0457984ed4510b4921b621c5355e4c308e8de70ce6b0f90e9" }, "downloads": -1, "filename": "imongo_kernel-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "8cafb1df1ec8cc059fe923c1c4bdd24c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 11217, "upload_time": "2017-10-04T10:16:30", "url": "https://files.pythonhosted.org/packages/94/9e/3d9acb8e8f948aef6454b066f1a1b8fab02def7b8661b0e9ab544d12e18d/imongo_kernel-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f786f2a93d6206750659e14116d7d602", "sha256": "d83cae1e7dca5ebe3cf80ab59cc1b568afb476201778347db42685006364e415" }, "downloads": -1, "filename": "imongo-kernel-0.1.0.tar.gz", "has_sig": false, "md5_digest": "f786f2a93d6206750659e14116d7d602", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8572, "upload_time": "2017-10-04T10:16:31", "url": "https://files.pythonhosted.org/packages/f4/ac/3b2978895b92a229bf898721a51bf4ecebcfb9cebd087bf92ddef2580133/imongo-kernel-0.1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "8cafb1df1ec8cc059fe923c1c4bdd24c", "sha256": "f6f2322a19a084a0457984ed4510b4921b621c5355e4c308e8de70ce6b0f90e9" }, "downloads": -1, "filename": "imongo_kernel-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "8cafb1df1ec8cc059fe923c1c4bdd24c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 11217, "upload_time": "2017-10-04T10:16:30", "url": "https://files.pythonhosted.org/packages/94/9e/3d9acb8e8f948aef6454b066f1a1b8fab02def7b8661b0e9ab544d12e18d/imongo_kernel-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f786f2a93d6206750659e14116d7d602", "sha256": "d83cae1e7dca5ebe3cf80ab59cc1b568afb476201778347db42685006364e415" }, "downloads": -1, "filename": "imongo-kernel-0.1.0.tar.gz", "has_sig": false, "md5_digest": "f786f2a93d6206750659e14116d7d602", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8572, "upload_time": "2017-10-04T10:16:31", "url": "https://files.pythonhosted.org/packages/f4/ac/3b2978895b92a229bf898721a51bf4ecebcfb9cebd087bf92ddef2580133/imongo-kernel-0.1.0.tar.gz" } ] }