{ "info": { "author": "David Pursehouse", "author_email": "david.pursehouse@sonymobile.com", "bugtrack_url": null, "classifiers": [], "description": "Pygerrit - Client library for interacting with Gerrit Code Review\n=================================================================\n\n.. image:: https://img.shields.io/pypi/v/pygerrit.png\n\n.. image:: https://img.shields.io/pypi/dm/pygerrit.png\n\n.. image:: https://img.shields.io/pypi/l/pygerrit.png\n\nPygerrit provides a simple interface for clients to interact with\n`Gerrit Code Review`_ via ssh or the REST API.\n\nPrerequisites\n-------------\n\nPygerrit has been tested on Ubuntu 10.4 and Mac OSX 10.8.4, with Python 2.6.x\nand 2.7.x. Support for other platforms and Python versions is not guaranteed.\n\nPygerrit depends on the `paramiko`_ and `requests`_ libraries.\n\n\nInstallation\n------------\n\nTo install pygerrit, simply::\n\n $ pip install pygerrit\n\n\nConfiguration\n-------------\n\nFor easier connection to the review server over ssh, the ssh connection\nparameters (hostname, port, username) can be given in the user's ``.ssh/config``\nfile::\n\n Host review\n HostName review.example.net\n Port 29418\n User username\n\n\nFor easier connection to the review server over the REST API, the user's\nHTTP username and password can be given in the user's ``.netrc`` file::\n\n machine review login MyUsername password MyPassword\n\n\nFor instructions on how to obtain the HTTP password, refer to Gerrit's\n`HTTP upload settings`_ documentation.\n\n\nSSH Interface\n-------------\n\nThe SSH interface can be used to run commands on the Gerrit server::\n\n >>> from pygerrit.ssh import GerritSSHClient\n >>> client = GerritSSHClient(\"review\")\n >>> result = client.run_gerrit_command(\"version\")\n >>> result\n \n >>> result.stdout\n >>\n >>> result.stdout.read()\n 'gerrit version 2.6.1\\n'\n >>>\n\nEvent Stream\n------------\n\nGerrit offers a ``stream-events`` command that is run over ssh, and returns back\na stream of events (new change uploaded, change merged, comment added, etc) as\nJSON text.\n\nThis library handles the parsing of the JSON text from the event stream,\nencapsulating the data in event objects (Python classes), and allowing the\nclient to fetch them from a queue. It also allows users to easily add handling\nof custom event types, for example if they are running a customised Gerrit\ninstallation with non-standard events::\n\n >>> from pygerrit.client import GerritClient\n >>> client = GerritClient(\"review\")\n >>> client.gerrit_version()\n '2.6.1'\n >>> client.start_event_stream()\n >>> client.get_event()\n : \n >>> client.get_event()\n : \n >>> client.stop_event_stream()\n >>>\n\n\nRefer to the `example`_ script for a more detailed example of how the SSH\nevent stream interface works.\n\nREST API\n--------\n\nThis simple example shows how to get the user's open changes, authenticating\nto Gerrit via HTTP Digest authentication using an explicitly given username and\npassword::\n\n >>> from requests.auth import HTTPDigestAuth\n >>> from pygerrit.rest import GerritRestAPI\n >>> auth = HTTPDigestAuth('username', 'password')\n >>> rest = GerritRestAPI(url='http://review.example.net', auth=auth)\n >>> changes = rest.get(\"/changes/?q=owner:self%20status:open\")\n\n\nRefer to the `rest_example`_ script for a more detailed example of how the\nREST API interface works.\n\n\nCopyright and License\n---------------------\n\nCopyright 2011 Sony Ericsson Mobile Communications. All rights reserved.\n\nCopyright 2012 Sony Mobile Communications. All rights reserved.\n\nLicensed under The MIT License. Please refer to the `LICENSE`_ file for full\nlicense details.\n\n.. _`Gerrit Code Review`: https://code.google.com/p/gerrit/\n.. _`requests`: https://github.com/kennethreitz/requests\n.. _`paramiko`: https://github.com/paramiko/paramiko\n.. _example: https://github.com/sonyxperiadev/pygerrit/blob/master/example.py\n.. _rest_example: https://github.com/sonyxperiadev/pygerrit/blob/master/rest_example.py\n.. _`HTTP upload settings`: https://gerrit-documentation.storage.googleapis.com/Documentation/2.8/user-upload.html#http\n.. _LICENSE: https://github.com/sonyxperiadev/pygerrit/blob/master/LICENSE", "description_content_type": null, "docs_url": "https://pythonhosted.org/pygerrit/", "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/sonyxperiadev/pygerrit", "keywords": "gerrit", "license": "The MIT License", "maintainer": "", "maintainer_email": "", "name": "pygerrit", "package_url": "https://pypi.org/project/pygerrit/", "platform": null, "project_url": "https://pypi.org/project/pygerrit/", "project_urls": { "Homepage": "https://github.com/sonyxperiadev/pygerrit" }, "release_url": "https://pypi.org/project/pygerrit/1.0.0/", "requires_dist": null, "requires_python": "", "summary": "Client library for interacting with Gerrit", "version": "1.0.0" }, "last_serial": 2388217, "releases": { "0.0.5": [], "0.0.7": [ { "comment_text": "", "digests": { "md5": "c0c5d155bb2aafa549df5ea67fc56cf7", "sha256": "b23f46ce7f16369eeb65f0915587efd77ae16196f8c11ae8199c4b168fc13940" }, "downloads": -1, "filename": "pygerrit-0.0.7.tar.gz", "has_sig": false, "md5_digest": "c0c5d155bb2aafa549df5ea67fc56cf7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6799, "upload_time": "2013-08-06T06:06:07", "url": "https://files.pythonhosted.org/packages/e4/08/8439176c2847c6081cbf7bc1c9551b7ec885dfad8d73573e0e7a23ad47bd/pygerrit-0.0.7.tar.gz" } ], "0.1.0": [ { "comment_text": "", "digests": { "md5": "b8c64e15eac7d54a69551acd3eb545ea", "sha256": "041e93ee5b309db8c243596addcc28e7f5488fe8086c744d89b78a0697e9c093" }, "downloads": -1, "filename": "pygerrit-0.1.0.tar.gz", "has_sig": false, "md5_digest": "b8c64e15eac7d54a69551acd3eb545ea", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8338, "upload_time": "2013-08-09T03:09:50", "url": "https://files.pythonhosted.org/packages/49/f8/4f777f348a1da60f9ad397f901a9ed488bdbb753a08400f37ee3144e38c6/pygerrit-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "61cbeefac9d1b4259b72d7d17769471b", "sha256": "6b0e36ae6f8bffb3282b36c45b2d18311096b159f65e83f717503334fcc5fa09" }, "downloads": -1, "filename": "pygerrit-0.1.1.tar.gz", "has_sig": false, "md5_digest": "61cbeefac9d1b4259b72d7d17769471b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8894, "upload_time": "2013-09-13T04:42:27", "url": "https://files.pythonhosted.org/packages/59/41/71240bec3d3808433db38007efc871140918fe410e1edbe4ac75d8ed2e80/pygerrit-0.1.1.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "161ae322ba02499ca93ad8fff0ae9ec1", "sha256": "55a82c8a903f62c13bb061a612865f83ce45c8f97b77993ee87f2ece5dad0865" }, "downloads": -1, "filename": "pygerrit-0.2.1.tar.gz", "has_sig": false, "md5_digest": "161ae322ba02499ca93ad8fff0ae9ec1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9913, "upload_time": "2013-10-25T13:30:07", "url": "https://files.pythonhosted.org/packages/fe/99/46086a6cac92be46bb4c65eba6dd98abb39396a29fdb2b368fa2eae3712b/pygerrit-0.2.1.tar.gz" } ], "0.2.10": [ { "comment_text": "", "digests": { "md5": "094e3a81a5d0e843069ab433a24a2fa4", "sha256": "6a483bf790bc1c2767fb13b04bc06899a584dd7dc154cd1a523f06524eb00309" }, "downloads": -1, "filename": "pygerrit-0.2.10.tar.gz", "has_sig": false, "md5_digest": "094e3a81a5d0e843069ab433a24a2fa4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 23348, "upload_time": "2015-06-29T09:00:29", "url": "https://files.pythonhosted.org/packages/69/0e/33db0d28ae6385826c6facdf9292a0fc57dd6a2da2e8982800482b9b9163/pygerrit-0.2.10.tar.gz" } ], "0.2.11": [ { "comment_text": "", "digests": { "md5": "d2d21d99935d2f408ac7cf7254dcefff", "sha256": "4d11a4e3553dca9b47873a8fe10d5ec102c1edba0f4a72421ccb2592ff315525" }, "downloads": -1, "filename": "pygerrit-0.2.11.tar.gz", "has_sig": false, "md5_digest": "d2d21d99935d2f408ac7cf7254dcefff", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 23505, "upload_time": "2015-07-28T02:38:40", "url": "https://files.pythonhosted.org/packages/09/1f/8f91ae81b8b28c1b9fae97512afacd3668b6e4eb74cd68e08238bdf6faa6/pygerrit-0.2.11.tar.gz" } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "1c0d02d36a6cd5c1490b9fdc3b0333b2", "sha256": "c5b5f3f887bc1bb204ef0ad56fec5ac97a281f499f35cbd16c4140ddeb793f48" }, "downloads": -1, "filename": "pygerrit-0.2.2.tar.gz", "has_sig": false, "md5_digest": "1c0d02d36a6cd5c1490b9fdc3b0333b2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10103, "upload_time": "2013-11-18T11:56:08", "url": "https://files.pythonhosted.org/packages/08/a0/71205dc1d620f99324b8704e0f1ab5a8ead3c99ee0585c223ac2f591466b/pygerrit-0.2.2.tar.gz" } ], "0.2.3": [ { "comment_text": "", "digests": { "md5": "28250b56391ad5c6b28bf5a6424e150e", "sha256": "659d7b84d354660d93c656253098b74d428faaec3c4a168241d8fea654984b60" }, "downloads": -1, "filename": "pygerrit-0.2.3.tar.gz", "has_sig": false, "md5_digest": "28250b56391ad5c6b28bf5a6424e150e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13186, "upload_time": "2014-03-04T15:45:39", "url": "https://files.pythonhosted.org/packages/8a/76/efdb34a40ead139f86b82df8ff02dcf8bcae2eb5f636509346ee058b54a8/pygerrit-0.2.3.tar.gz" } ], "0.2.4": [ { "comment_text": "", "digests": { "md5": "624f232877da5e75d95685a067b2e07b", "sha256": "4c43f50db996d55c56ea77788f356dbda3ffae690aa864e89ddb30a588a57c81" }, "downloads": -1, "filename": "pygerrit-0.2.4.tar.gz", "has_sig": false, "md5_digest": "624f232877da5e75d95685a067b2e07b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12754, "upload_time": "2014-03-17T05:06:19", "url": "https://files.pythonhosted.org/packages/3f/6d/34f04479af1d912e70696f9366279791de9a0b62420ae865ea8f1a84ac41/pygerrit-0.2.4.tar.gz" } ], "0.2.5": [], "0.2.6": [ { "comment_text": "", "digests": { "md5": "458fd0acd7e3c2a454367e58f1254cb5", "sha256": "96c7a50f7ee1a5c1c235de692ea8f8e9db533a157601af2f99a57302e83b9699" }, "downloads": -1, "filename": "pygerrit-0.2.6.tar.gz", "has_sig": false, "md5_digest": "458fd0acd7e3c2a454367e58f1254cb5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 20329, "upload_time": "2015-06-12T10:00:53", "url": "https://files.pythonhosted.org/packages/89/f7/5f9d1ff406fa5230e3d02db8d337d502a9e7271b624efa5872783d5c0efc/pygerrit-0.2.6.tar.gz" } ], "0.2.7": [ { "comment_text": "", "digests": { "md5": "0670f3faeeb81a90c069627d75938133", "sha256": "c44c46fe19ac6c683a24c5b281ae806bc6ba5f224ea266482892b439153c24f9" }, "downloads": -1, "filename": "pygerrit-0.2.7.tar.gz", "has_sig": false, "md5_digest": "0670f3faeeb81a90c069627d75938133", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 21826, "upload_time": "2015-06-12T10:00:57", "url": "https://files.pythonhosted.org/packages/46/3a/84f5451a7d1a7a4b4ea515b2570d539a804ff89775b1a448f2f9df8dbc94/pygerrit-0.2.7.tar.gz" } ], "0.2.8": [ { "comment_text": "", "digests": { "md5": "ecb2ae389fa97d999519a2dd2539b424", "sha256": "63004967f481655007be530bc81a68790a055a2ad54c38d0feca5fcb1c0337f4" }, "downloads": -1, "filename": "pygerrit-0.2.8.tar.gz", "has_sig": false, "md5_digest": "ecb2ae389fa97d999519a2dd2539b424", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 24211, "upload_time": "2015-06-12T10:01:02", "url": "https://files.pythonhosted.org/packages/8d/cb/93a2efcb0aacbd181eb60ea70b5291eeb1633b58758307565286a9f9038a/pygerrit-0.2.8.tar.gz" } ], "0.2.9": [ { "comment_text": "", "digests": { "md5": "9eb885714d643c1a63443a58dcdc8793", "sha256": "559783ed3dec4dc25404dfbdc785ad32ccc311c51a51ad87ad6e8dc9b60f3684" }, "downloads": -1, "filename": "pygerrit-0.2.9.tar.gz", "has_sig": false, "md5_digest": "9eb885714d643c1a63443a58dcdc8793", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 24701, "upload_time": "2015-06-12T10:01:06", "url": "https://files.pythonhosted.org/packages/f1/27/5d90605d32fb0b32bcac38e96e3e51cebd1969ab2884a0de0871a9f6d9e7/pygerrit-0.2.9.tar.gz" } ], "1.0.0": [ { "comment_text": "", "digests": { "md5": "7a1fb8842fcab106e93bf563ccd351fb", "sha256": "9f206b64423fb3dccc7cdef1f27713b843349ce601638066cb5a9c4a07f40389" }, "downloads": -1, "filename": "pygerrit-1.0.0.tar.gz", "has_sig": false, "md5_digest": "7a1fb8842fcab106e93bf563ccd351fb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 25472, "upload_time": "2016-04-19T13:39:37", "url": "https://files.pythonhosted.org/packages/04/9b/fd6b6169c59b2e5d19a5b50b0d9ab18ffd3126726e4a2dd9f0dcfd7ca2e6/pygerrit-1.0.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "7a1fb8842fcab106e93bf563ccd351fb", "sha256": "9f206b64423fb3dccc7cdef1f27713b843349ce601638066cb5a9c4a07f40389" }, "downloads": -1, "filename": "pygerrit-1.0.0.tar.gz", "has_sig": false, "md5_digest": "7a1fb8842fcab106e93bf563ccd351fb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 25472, "upload_time": "2016-04-19T13:39:37", "url": "https://files.pythonhosted.org/packages/04/9b/fd6b6169c59b2e5d19a5b50b0d9ab18ffd3126726e4a2dd9f0dcfd7ca2e6/pygerrit-1.0.0.tar.gz" } ] }