{ "info": { "author": "Kevin J. Qiu", "author_email": "kevin@idempotent.ca", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5" ], "description": "cdbcli - CouchDB Interactive Shell\n==================================\n\n.. image:: https://img.shields.io/pypi/v/cdbcli.svg\n :target: https://pypi.python.org/pypi/cdbcli\n :alt: Latest PyPI version\n\n.. image:: https://travis-ci.org/kevinjqiu/cdbcli.svg?branch=master\n :target: https://travis-ci.org/kevinjqiu/cdbcli\n :alt: Latest Travis CI build status for master\n\n.. image:: https://readthedocs.org/projects/cdbcli/badge/?version=latest\n :target: https://cdbcli.readthedocs.io/en/latest/\n :alt: Documentation Status\n\n.. image:: https://coveralls.io/repos/github/kevinjqiu/cdbcli/badge.svg\n :target: https://coveralls.io/github/kevinjqiu/cdbcli\n :alt: Code Coverage\n\n.. image:: https://img.shields.io/badge/license-Apache%202.0-blue.svg\n :target: LICENSE\n :alt: License\n\n.. image:: https://img.shields.io/badge/docker-kevinjqiu%2Fcdbcli-blue.svg\n :target: https://hub.docker.com/r/kevinjqiu/cdbcli/\n :alt: Image on Docker Hub\n\n.. image:: https://img.shields.io/badge/aur-cdbcli-blue.svg\n :target: https://aur.archlinux.org/packages/cdbcli/\n :alt: Arch User Repository\n\nFeatures\n--------\n\n- auto-completion for database name, document id, view name, command\n- syntax highlighting of documents and views\n- navigate a couchdb server as if it were a file system\n- various commands supported\n * cd - change database\n * ls - list docs under a database\n * cat - show content of a doc\n * exec - execute a view\n * rm - remove a doc\n * man - show help on commands\n * mkdir - create new database\n * du - doc and database size\n * lv - list views inside a view doc\n- create/update docs using external ``$EDITOR``\n- pipe output to external shell commands, such as ``grep``, ``wc`` and ``jq``\n\nDemo\n----\n\n.. image:: https://asciinema.org/a/1mj2j4cxhqmq5m6t16tm82ws8.png\n :scale: 50%\n :target: https://asciinema.org/a/1mj2j4cxhqmq5m6t16tm82ws8\n\nUsage\n-----\n\nThis tool allows you to traverse a CouchDB database as if it were a file system. Familiar file system commands are supported, such as ``ls``, ``cd``, ``mkdir``, ``rm``, etc, while providing context-rich auto-completion.\n\nStarting cdbcli\n^^^^^^^^^^^^^^^\n\nRefer to the Installation_ section for guide on how to install cdbcli.\n\nRunning cdbcli requires connection parameters to the underlying couchdb instance you want to connnect to.\n\n.. code::\n\n\tcdbcli --help\n\n\tUsage: cdbcli [OPTIONS] [DATABASE]\n\n\tOptions:\n\t -h, --host TEXT The host of the couchdb instance\n\t --port TEXT The port of the coouchdb instance\n\t -u, --username TEXT The username to connect as\n\t -p, --password TEXT The password\n\t -P, --askpass / --no-askpass Ask for password?\n\t --tls / --no-tls Use TLS to connect to the couchdb instance?\n\t --help Show this message and exit.\n\ne.g., if you want to connect your couchdb instance at http://yourdomain:9999, you can issue the command::\n\n cdbcli -h yourdomain --port 9999 -u admin -P\n\nSpecifying ``-P`` will prompt you for password. You can also use ``-p`` to specify password at the command line, but this is not recommended for sensitive passwords.\n\nBy default, ``cdbcli`` connects to the couchdb instance at http://localhost:5984.\n\n\nYou will be greeted by the cdbcli's splash screen::\n\n ___ ____ ____ ___ __ ____\n / __)( _ \\( _ \\ / __)( ) (_ _)\n ( (__ )(_) )) _ <( (__ )(__ _)(_\n \\___)(____/(____/ \\___)(____)(____)\n\n Welcome to cdbcli 0.1.1\n CouchDB version: 1.5.0\n\n Type 'help' or 'man' to get a list of all supported commands\n Press for command auto-completion\n Press Ctrl+C or Ctrl+D or type 'exit' to exit\n\n admin@yourdomain/>\n\nRun with Docker\n^^^^^^^^^^^^^^^\n\n``cdbcli`` is also available as a docker image on the `docker hub `_\n\nTo run::\n\n docker run -it kevinjqiu/cdbcli cdbcli \n\nThe docker networking restrictions apply, so if you want to connect to a database on localhost, e.g., you will need to let the container use the host's networking::\n\n docker run -it --net=host kevinjqiu/cdbcli cdbcli \n\nInstallation\n------------\n\n.. code::\n\n pip install cdbcli\n\n\nContributing\n------------\n\n* Clone this repository.\n* Make a Python virtualenv\n* Install requirements: ``pip install -r requirements-test.txt``\n* Install `docker `_ because the integration tests require it\n* Run ``make start_couchdb``. This will start the testing couchdb instance using docker\n* Run ``make test``\n* Run ``make stop_couchdb`` to clean up\n\nContributing to Documentation\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n* Clone this repository.\n* Make a Python virtualenv\n* Install requirements: ``pip install -r requirements-docs.txt``\n* Run ``make docs``. The documentation can be accessed under docs/build/index.html.\n\nLicence\n-------\n\n``cdbcli`` is licensed under Apache 2.0\n\n\nAuthors\n-------\n\n`cdbcli` was written by `Kevin J. Qiu `_.\n\nSee `all contributors `_\n\nAttribution\n-----------\n\n* `python-prompt-toolkit `_ by Jonathan Slenders\n* `click `_ by Armin Ronacher", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/kevinjqiu/cdbcli", "keywords": null, "license": "UNKNOWN", "maintainer": null, "maintainer_email": null, "name": "cdbcli", "package_url": "https://pypi.org/project/cdbcli/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/cdbcli/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/kevinjqiu/cdbcli" }, "release_url": "https://pypi.org/project/cdbcli/0.9.1/", "requires_dist": null, "requires_python": null, "summary": "Interactive command line shell for CouchDB", "version": "0.9.1" }, "last_serial": 2263435, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "d430b04ca95cf26e3f736d9c39c2549c", "sha256": "909b4de99298118e5deb7e39fec47b678685b20a0de38a1d30516850d259adec" }, "downloads": -1, "filename": "cdbcli-0.1.0-py2-none-any.whl", "has_sig": false, "md5_digest": "d430b04ca95cf26e3f736d9c39c2549c", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 9116, "upload_time": "2016-07-15T04:17:22", "url": "https://files.pythonhosted.org/packages/01/ec/58d4f30ad11b78c03a05f0babbf77018af01b0d24547882fb221d0c2460a/cdbcli-0.1.0-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "8a72b0d653c87029dab72fd1b7d484fe", "sha256": "7f1062671b768cfaf50f19d51ff11a677ae1c229723e221f6b389506338c8c30" }, "downloads": -1, "filename": "cdbcli-0.1.0.tar.gz", "has_sig": false, "md5_digest": "8a72b0d653c87029dab72fd1b7d484fe", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5276, "upload_time": "2016-07-15T04:17:20", "url": "https://files.pythonhosted.org/packages/68/98/3031960e7d0303c6651eb16f47328956a648bb920156948d50cd5ac6e58f/cdbcli-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "85151798b9749a952f90915d08b10bcf", "sha256": "1387275eea95eac019fbdc56402303a6ef6dbaab59b790bf12d5098dfdc68463" }, "downloads": -1, "filename": "cdbcli-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "85151798b9749a952f90915d08b10bcf", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 26626, "upload_time": "2016-07-20T01:13:57", "url": "https://files.pythonhosted.org/packages/d8/ec/d29c59481e9c33f00b2048a07a9edf5e95a40cd83163eea0086df1a6f4b7/cdbcli-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3138485c3718549f7af68c0c3daf6df4", "sha256": "832ec10f50800e7f1bd695523e61cf786ef6bccb6e3cd117e903e5c4e117616d" }, "downloads": -1, "filename": "cdbcli-0.1.1.tar.gz", "has_sig": false, "md5_digest": "3138485c3718549f7af68c0c3daf6df4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8718, "upload_time": "2016-07-20T01:13:54", "url": "https://files.pythonhosted.org/packages/19/7c/2d624923531b101e5af988df735edb282f8934480af397b8dd35b5b8b9d4/cdbcli-0.1.1.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "bbd39481a4c7c990da41ba59712c3da2", "sha256": "9392d2ed1d6d33c7ce23228ffe1fabb8c713f2c65690db53e40b6f18ee4e5f8a" }, "downloads": -1, "filename": "cdbcli-0.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "bbd39481a4c7c990da41ba59712c3da2", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 33694, "upload_time": "2016-08-01T03:50:01", "url": "https://files.pythonhosted.org/packages/27/d1/22025f8bf97527a55dd34dcf061e3f74269102a14b0024e2d17b39089797/cdbcli-0.2.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d12c68be5d2455a2bd1a94ef7b9a01cd", "sha256": "0ecf02b60329ddcb20facf9733a64962e271c7b04465ed63d42b98c13cfc9ee2" }, "downloads": -1, "filename": "cdbcli-0.2.0.tar.gz", "has_sig": false, "md5_digest": "d12c68be5d2455a2bd1a94ef7b9a01cd", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15794, "upload_time": "2016-08-01T03:49:58", "url": "https://files.pythonhosted.org/packages/dc/81/138409cdae368ef50b8fd938ff558eeb0159ed2d9647eafcb6b4822b691d/cdbcli-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "4f2d8bd902ebcd94885dbc880aa9acc2", "sha256": "245e219d4b8c55e7bd587f0a53df25b28b1e25978447dc72d9f8c50ab9f49238" }, "downloads": -1, "filename": "cdbcli-0.2.1-py3-none-any.whl", "has_sig": false, "md5_digest": "4f2d8bd902ebcd94885dbc880aa9acc2", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 34742, "upload_time": "2016-08-01T04:39:26", "url": "https://files.pythonhosted.org/packages/d4/52/e90e5c1d50f01f81c0f9904bf453e9ac1297a178685ef67b7ff9ee13418e/cdbcli-0.2.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e8517838b2098205dbd2c07b313eebaa", "sha256": "eebf852e7fb5b9279b83dccac0a0a9bff7c28b3b8f482d4e608b19cc87b93f83" }, "downloads": -1, "filename": "cdbcli-0.2.1.tar.gz", "has_sig": false, "md5_digest": "e8517838b2098205dbd2c07b313eebaa", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17145, "upload_time": "2016-08-01T04:39:23", "url": "https://files.pythonhosted.org/packages/d2/9c/85cbf6be1c7d330a48847ec44b4f84794d150c493c6bb0d7270e172a40dd/cdbcli-0.2.1.tar.gz" } ], "0.9.0": [ { "comment_text": "", "digests": { "md5": "fba50454b9e3352cbe0508ddaaf53d4c", "sha256": "6bba58b0dea3ca8f5de57b277ad4b1f5daf867ed574b8f9d66e9c6696e9e07a3" }, "downloads": -1, "filename": "cdbcli-0.9.0-py3-none-any.whl", "has_sig": false, "md5_digest": "fba50454b9e3352cbe0508ddaaf53d4c", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 35377, "upload_time": "2016-08-05T04:03:43", "url": "https://files.pythonhosted.org/packages/de/a9/9f49f3ffd7aa7f9cad63282e82dceae518a9ea27e5c097fdb8f308b05313/cdbcli-0.9.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "953d4dafda10e24bd12074e7045bc0cc", "sha256": "8e0f4f22cca0fd65d5b5a7ad919fa4fc64066fed60497b2e08697dcd1d6473b8" }, "downloads": -1, "filename": "cdbcli-0.9.0.tar.gz", "has_sig": false, "md5_digest": "953d4dafda10e24bd12074e7045bc0cc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17794, "upload_time": "2016-08-05T04:03:36", "url": "https://files.pythonhosted.org/packages/fc/02/2cd6d525e422938368d99f4ab8c419b352d967b3c8e616b8cd61342e54f7/cdbcli-0.9.0.tar.gz" } ], "0.9.1": [ { "comment_text": "", "digests": { "md5": "34559a1c5828b0a45d30363eaf5e78d8", "sha256": "bd056f2e50d5121ad379ee371d1399de8fd5a899018c43c4a3acf3ddb8544bcd" }, "downloads": -1, "filename": "cdbcli-0.9.1-py3-none-any.whl", "has_sig": false, "md5_digest": "34559a1c5828b0a45d30363eaf5e78d8", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 35374, "upload_time": "2016-08-05T04:07:34", "url": "https://files.pythonhosted.org/packages/b7/eb/b7b560e8ca62e46df43405da44074b23154df8e23090a833e23478e09e6f/cdbcli-0.9.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "70bfc4ed013ee661eef77b0959186938", "sha256": "7fede909e8fc256cadfeae820fffe4a4cf4258ddc47b409917e77209db762585" }, "downloads": -1, "filename": "cdbcli-0.9.1.tar.gz", "has_sig": false, "md5_digest": "70bfc4ed013ee661eef77b0959186938", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17784, "upload_time": "2016-08-05T04:07:26", "url": "https://files.pythonhosted.org/packages/ff/71/25fd3c4e152df91e2177302fb73bc5e6c85617175f206a1a179a65351d6c/cdbcli-0.9.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "34559a1c5828b0a45d30363eaf5e78d8", "sha256": "bd056f2e50d5121ad379ee371d1399de8fd5a899018c43c4a3acf3ddb8544bcd" }, "downloads": -1, "filename": "cdbcli-0.9.1-py3-none-any.whl", "has_sig": false, "md5_digest": "34559a1c5828b0a45d30363eaf5e78d8", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 35374, "upload_time": "2016-08-05T04:07:34", "url": "https://files.pythonhosted.org/packages/b7/eb/b7b560e8ca62e46df43405da44074b23154df8e23090a833e23478e09e6f/cdbcli-0.9.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "70bfc4ed013ee661eef77b0959186938", "sha256": "7fede909e8fc256cadfeae820fffe4a4cf4258ddc47b409917e77209db762585" }, "downloads": -1, "filename": "cdbcli-0.9.1.tar.gz", "has_sig": false, "md5_digest": "70bfc4ed013ee661eef77b0959186938", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17784, "upload_time": "2016-08-05T04:07:26", "url": "https://files.pythonhosted.org/packages/ff/71/25fd3c4e152df91e2177302fb73bc5e6c85617175f206a1a179a65351d6c/cdbcli-0.9.1.tar.gz" } ] }