{ "info": { "author": "Micah Carrick", "author_email": "micah@janrain.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Internet :: WWW/HTTP", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "Janrain Python API\n==================\n\n|BuildStatus|_\n\n.. |BuildStatus| image:: https://travis-ci.org/janrain/janrain-python-api.png?branch=master\n.. _BuildStatus: https://travis-ci.org/janrain/janrain-python-api\n\nPython interface to the\n`Janrain Capture `_ API.\n\n\nInstall\n-------\n\nDownload and install the most recent stable version using ``pip``::\n\n pip install janrain-python-api\n\n\nTo use the unstable developement version, download the package by cloning the git repository::\n\n git clone https://github.com/janrain/janrain-python-api.git\n cd janrain-python-api\n python setup.py install\n\n\nBasic Usage\n-----------\n\nLow-Level API Calls\n~~~~~~~~~~~~~~~~~~~\n\nUse ``janrain.capture.Api`` to make low-level calls to the API.\n\n.. code-block:: python\n\n from janrain.capture import Api\n\n defaults = {\n 'client_id': \"YOUR_CLIENT_ID\",\n 'client_secret': \"YOUR_CLIENT_SECRET\"\n }\n\n api = Api(\"https://YOUR_APP.janraincapture.com\", defaults)\n result = api.call(\"entity.count\", type_name=\"user\")\n print(result)\n\n\nExceptions\n~~~~~~~~~~\n\nExceptions are derived from ``JanrainApiException`` which includes error\nresponses from the API. A try/catch bock should wrap any functions or methods\nthat call the Janrain API.\n\n.. code-block:: python\n\n import sys\n from janrain.capture import Api, ApiResponseError\n from requests import HTTPError\n\n defaults = {\n 'client_id': \"YOUR_CLIENT_ID\",\n 'client_secret': \"YOUR_CLIENT_SECRET\"\n }\n\n api = Api(\"https://YOUR_APP.janraincapture.com\", defaults)\n\n try:\n result = api.call(\"entity.find\", type_name=\"user\")\n except ApiResponseError as error:\n # Janrain API returned an error response\n sys.exit(str(error))\n except HTTPError as error:\n # Python 'requests' library returned an error\n sys.exit(str(error))\n\n\nArgument Parser\n~~~~~~~~~~~~~~~\n\nThe library includes a subclass of the Python\n`argparse `_ configured to\naccept credentials for authenticating with the Janrain API. This can be used to\nsimplify passing in credentials in custom command-line scripts.\n\n.. code-block:: python\n\n from janrain.capture import cli\n\n parser = cli.ApiArgumentParser()\n args = parser.parse_args()\n api = parser.init_api()\n\nWhich can then invoke from the command-line as follows::\n\n python myscript.py --api-url=[YOUR_CAPTURE_URL] \\\n --client-id=[YOUR_CLIENT_ID] \\\n --client-secret=[YOUR_CLIENT_SECRET] \\\n\n\nCommand-Line Utility\n--------------------\n\nThe package installs an executable named ``capture-api`` for making\nAPI calls from the command-line.\n\nAuthenticate with the API by passing ``--api-url``, ``--client-id``,\nand ``--client-secret``, then pass the API call, and then any parameters to\nsend to the API as key=value pairs after the ``--parameters`` argument.\n\nExamples\n~~~~~~~~\n\nPassing the authentication credentials::\n\n capture-api --api-url=[YOUR_CAPTURE_URL] \\\n --client-id=[YOUR_CLIENT_ID] \\\n --client-secret=[YOUR_CLIENT_SECRET] \\\n entity.count --parameters type_name=user\n\nEnclose JSON values in single outer-quotes and double inner-quotes::\n\n capture-api --api-url=[YOUR_CAPTURE_URL] \\\n --client-id=[YOUR_CLIENT_ID] \\\n --client-secret=[YOUR_CLIENT_SECRET] \\\n entity.find --parameters type_name=user \\\n attributes='[\"displayName\",\"email\"]'\n\nEnclose filters in double outer-quotes and single inner-quotes::\n\n capture-api --api-url=[YOUR_CAPTURE_URL] \\\n --client-id=[YOUR_CLIENT_ID] \\\n --client-secret=[YOUR_CLIENT_SECRET] \\\n entity.find --parameters type_name=user \\\n filter=\"email = 'demo@janrain.com' and birthday is null\"\n\n----\n\nVersioning\n----------\nThis software follows Semantic Versioning convention.\nhttp://semver.org/\n\n\nCopyright \u00a9 2014 Janrain, Inc. All Rights Reserved.", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://developers.janrain.com/", "keywords": null, "license": "UNKNOWN", "maintainer": null, "maintainer_email": null, "name": "janrain-python-api", "package_url": "https://pypi.org/project/janrain-python-api/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/janrain-python-api/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://developers.janrain.com/" }, "release_url": "https://pypi.org/project/janrain-python-api/0.4.0/", "requires_dist": null, "requires_python": null, "summary": "Python interface to the Janrain Capture API.", "version": "0.4.0" }, "last_serial": 2053995, "releases": { "0.1.2": [ { "comment_text": "", "digests": { "md5": "2cde1ede26ced5ad24d676a0a2fe103d", "sha256": "1aa44406b6c0462bb30f5587684b11b8803d4e22b89c75c49699e7e756ef2c9a" }, "downloads": -1, "filename": "janrain-python-api-0.1.2.tar.gz", "has_sig": false, "md5_digest": "2cde1ede26ced5ad24d676a0a2fe103d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7710, "upload_time": "2013-03-20T23:21:33", "url": "https://files.pythonhosted.org/packages/4c/92/dff5e1622d8d015265265e8ecc76f9f8fc20ee16710447ee4309c71062ee/janrain-python-api-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "1a80ba88934621848a0b43541d2233f3", "sha256": "334b41314c75e154690e8d4eba7b27a17eaf684ec729e52c8d331540fc4b80c4" }, "downloads": -1, "filename": "janrain-python-api-0.1.3.tar.gz", "has_sig": false, "md5_digest": "1a80ba88934621848a0b43541d2233f3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12837, "upload_time": "2013-03-20T23:41:21", "url": "https://files.pythonhosted.org/packages/72/d2/c0acfa497ee1b365c9c2711857acd40a41afd88b35c4df31de13c16c25d1/janrain-python-api-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "9d8cfa2780f844d5884b0d805315b081", "sha256": "65263a5df03e07e7c2abbdaeaf1bb8d194f21fddabedaa4b2c8b6e64c65396bf" }, "downloads": -1, "filename": "janrain-python-api-0.1.4.tar.gz", "has_sig": false, "md5_digest": "9d8cfa2780f844d5884b0d805315b081", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12844, "upload_time": "2013-04-07T15:03:18", "url": "https://files.pythonhosted.org/packages/39/75/9419c7e2dc739c81df350ea41d57bebf4721944c302d1b812125e1c75e74/janrain-python-api-0.1.4.tar.gz" } ], "0.1.5": [], "0.1.6": [ { "comment_text": "", "digests": { "md5": "7b0b4f37c0cf0c546a296caa6a30964d", "sha256": "e480ad7be6682cb2f19dd341d1dbbbd39d97c949b5d5bf7a78f67deaeb2f194d" }, "downloads": -1, "filename": "janrain-python-api-0.1.6.tar.gz", "has_sig": false, "md5_digest": "7b0b4f37c0cf0c546a296caa6a30964d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13696, "upload_time": "2013-05-06T20:01:59", "url": "https://files.pythonhosted.org/packages/14/ab/cc975c3034a96d95c6e97eac8342c31c41878ab30dc5ce9298b43ffe68c7/janrain-python-api-0.1.6.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "00a7c4edf31314f637e4a71391c4c421", "sha256": "64744b73151bb787380dbb61b9bd6dad4a8926275d46441fbf2fb4a970617164" }, "downloads": -1, "filename": "janrain-python-api-0.2.0.tar.gz", "has_sig": false, "md5_digest": "00a7c4edf31314f637e4a71391c4c421", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13772, "upload_time": "2013-08-01T16:49:52", "url": "https://files.pythonhosted.org/packages/fa/ce/b54095a905af56c3a4dd00acc25b32e2b64d038be0b898cf11e20523bc25/janrain-python-api-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "27f34425b76f3d5b5a7cfa3b37a9fe4f", "sha256": "9d035a6b51638e37c672e5ab72a9216a5f1f727d4934ea1b52b739502dd2d7b7" }, "downloads": -1, "filename": "janrain-python-api-0.2.1.tar.gz", "has_sig": false, "md5_digest": "27f34425b76f3d5b5a7cfa3b37a9fe4f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13795, "upload_time": "2013-09-08T15:51:39", "url": "https://files.pythonhosted.org/packages/99/c9/7add3f3a49513bf2f6ff8fb75c9b37731c8b8f280f5d70b537ecf0dcd797/janrain-python-api-0.2.1.tar.gz" } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "4f50ff6559d2784a6b0e0d84a07cfbf9", "sha256": "241ea959083ab3daf650349f1367a738a58e747987f9c056bede9208048fadc4" }, "downloads": -1, "filename": "janrain-python-api-0.2.2.tar.gz", "has_sig": false, "md5_digest": "4f50ff6559d2784a6b0e0d84a07cfbf9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13902, "upload_time": "2013-10-17T10:57:30", "url": "https://files.pythonhosted.org/packages/da/b4/e82ec6667252165674c681ffe7a3c4ae80abfb3143f7327e2423820ba17f/janrain-python-api-0.2.2.tar.gz" } ], "0.2.3": [ { "comment_text": "", "digests": { "md5": "7bbad224a7804b7dea719c4e2f662e9d", "sha256": "c1ea707cefc17656087b98fb0b65e8544c5087617f96ef65f9c682b8e8be8e64" }, "downloads": -1, "filename": "janrain-python-api-0.2.3.tar.gz", "has_sig": false, "md5_digest": "7bbad224a7804b7dea719c4e2f662e9d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15265, "upload_time": "2014-01-15T01:31:25", "url": "https://files.pythonhosted.org/packages/2c/84/b8b13bb44954f43d2ed71a887e68aee290c04e021c593e9f4b3a814b1fbc/janrain-python-api-0.2.3.tar.gz" } ], "0.2.4": [ { "comment_text": "", "digests": { "md5": "f85511688de25c627b4a8c6106be67f0", "sha256": "cf6c28b89b6f60428f4d828e0fbd0e0c035d273332a002a19b8ae399b833726e" }, "downloads": -1, "filename": "janrain-python-api-0.2.4.tar.gz", "has_sig": false, "md5_digest": "f85511688de25c627b4a8c6106be67f0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15456, "upload_time": "2014-03-15T14:16:55", "url": "https://files.pythonhosted.org/packages/5a/51/50d714009b18f805421be90ae1f1fadeb4b4eea9a86285472dfa05c7de4d/janrain-python-api-0.2.4.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "89aa1ab9525924960351cc218b7c220a", "sha256": "960d6a1d535dce4c917b5e26979176c1abe0414d53b90d8856f5df9315f4effc" }, "downloads": -1, "filename": "janrain-python-api-0.3.0.tar.gz", "has_sig": false, "md5_digest": "89aa1ab9525924960351cc218b7c220a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15313, "upload_time": "2014-10-27T22:10:12", "url": "https://files.pythonhosted.org/packages/b7/47/e0f6d0ef28fdffa2ea1154417bc337e1d98f9194741e180dd9d83fee3f36/janrain-python-api-0.3.0.tar.gz" }, { "comment_text": "", "digests": { "md5": "d46133da5cc9225464a045b734b549f3", "sha256": "3b62569889e4dffb4b1631a02435b00ec574b882f1ef5d02f7e99b55d7146cfb" }, "downloads": -1, "filename": "janrain-python-api-0.3.1.tar.gz", "has_sig": false, "md5_digest": "d46133da5cc9225464a045b734b549f3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16496, "upload_time": "2015-02-13T23:38:21", "url": "https://files.pythonhosted.org/packages/6b/ed/ea77fa88526ad1b66188b2962d48684bb5c0c0ac0b00ef0fac2ebfb0c927/janrain-python-api-0.3.1.tar.gz" } ], "0.3.1": [], "0.3.2": [ { "comment_text": "", "digests": { "md5": "7236c45293082439dabda3270ee0b063", "sha256": "f27bbf24f884ea4c4b40c5a27ae41ae7b8012a1f1f4e64a2a21582bb98950847" }, "downloads": -1, "filename": "janrain-python-api-0.3.2.tar.gz", "has_sig": false, "md5_digest": "7236c45293082439dabda3270ee0b063", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16571, "upload_time": "2015-03-04T21:49:05", "url": "https://files.pythonhosted.org/packages/e5/dc/065392acd8cbcf58d994d8dea900c3a1898e41d3ad6a1b15b67df7d98567/janrain-python-api-0.3.2.tar.gz" } ], "0.3.3": [ { "comment_text": "", "digests": { "md5": "f7ecb8ecf3ab7935570288ec3510eaa5", "sha256": "68bfcda54ff0ddcdb94e2d2063c23eac0a9e1746465a34fc656806814c8efad6" }, "downloads": -1, "filename": "janrain-python-api-0.3.3.tar.gz", "has_sig": false, "md5_digest": "f7ecb8ecf3ab7935570288ec3510eaa5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16620, "upload_time": "2015-04-06T22:34:55", "url": "https://files.pythonhosted.org/packages/75/3d/15480af6d8a47c3b6aae7a0d123b30406b195669dc1e3d37504122e2cd8e/janrain-python-api-0.3.3.tar.gz" } ], "0.3.4": [ { "comment_text": "", "digests": { "md5": "f70aba05fe1832c38a55a733e7f1d9c1", "sha256": "c4e646450775ed2a4651480b4a6b527865d2632546edb424ef9f66aebfae6b62" }, "downloads": -1, "filename": "janrain-python-api-0.3.4.tar.gz", "has_sig": false, "md5_digest": "f70aba05fe1832c38a55a733e7f1d9c1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16652, "upload_time": "2015-04-07T15:58:58", "url": "https://files.pythonhosted.org/packages/ab/49/f6d77f4434a5b1b6208eb16bc37ddda99e672d641f90a6f2a8ff524052ad/janrain-python-api-0.3.4.tar.gz" } ], "0.3.5": [ { "comment_text": "", "digests": { "md5": "aa1cde57cceb09f86cd0ae735eafeb3e", "sha256": "3171aed162491f145a9796bdc91870f507e6b2b62e4883f32117f018ff7b532b" }, "downloads": -1, "filename": "janrain-python-api-0.3.5.tar.gz", "has_sig": false, "md5_digest": "aa1cde57cceb09f86cd0ae735eafeb3e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16824, "upload_time": "2015-07-28T16:43:10", "url": "https://files.pythonhosted.org/packages/46/96/385157e46df6dd51e200733a50af213843bafb5c97b3ab41551ea374a36b/janrain-python-api-0.3.5.tar.gz" } ], "0.3.6": [ { "comment_text": "", "digests": { "md5": "2147471cdaaaf5e73823dc2e96c4a3a2", "sha256": "7e08edc0ec5da27c4f0a65985f03ba9de8dba8161e2116a41a139c7ab49508a8" }, "downloads": -1, "filename": "janrain-python-api-0.3.6.tar.gz", "has_sig": false, "md5_digest": "2147471cdaaaf5e73823dc2e96c4a3a2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16976, "upload_time": "2015-09-04T18:53:42", "url": "https://files.pythonhosted.org/packages/7a/57/16c2962b66183ad4bded45939c1e38c935b4fcc766665586fae37cffea38/janrain-python-api-0.3.6.tar.gz" } ], "0.3.7": [ { "comment_text": "", "digests": { "md5": "d47a7901d4bec8d16179a83ebe14ad04", "sha256": "e9a7cd4e9cd2a0f09b7a03f1a426fb67c872046151d7323b7b82979f516b8d3f" }, "downloads": -1, "filename": "janrain-python-api-0.3.7.tar.gz", "has_sig": false, "md5_digest": "d47a7901d4bec8d16179a83ebe14ad04", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17462, "upload_time": "2015-10-15T18:52:01", "url": "https://files.pythonhosted.org/packages/e3/85/c1355c0c81906ec233bdb587950ad2869a33822359305467f82fdb8d826e/janrain-python-api-0.3.7.tar.gz" } ], "0.4.0": [ { "comment_text": "", "digests": { "md5": "2c651e3f9439a74999c97afc8b59a318", "sha256": "fb3320f9eb0d80a471a7b7248a3919499d11c5bc974ec1b33473505c8f0ece5a" }, "downloads": -1, "filename": "janrain-python-api-0.4.0.tar.gz", "has_sig": false, "md5_digest": "2c651e3f9439a74999c97afc8b59a318", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17604, "upload_time": "2016-04-08T17:42:41", "url": "https://files.pythonhosted.org/packages/8f/eb/64e694dd15bf3b102b55eb57ab1b36edb8232e2dfb20d4e02fc1f89e2fe6/janrain-python-api-0.4.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "2c651e3f9439a74999c97afc8b59a318", "sha256": "fb3320f9eb0d80a471a7b7248a3919499d11c5bc974ec1b33473505c8f0ece5a" }, "downloads": -1, "filename": "janrain-python-api-0.4.0.tar.gz", "has_sig": false, "md5_digest": "2c651e3f9439a74999c97afc8b59a318", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17604, "upload_time": "2016-04-08T17:42:41", "url": "https://files.pythonhosted.org/packages/8f/eb/64e694dd15bf3b102b55eb57ab1b36edb8232e2dfb20d4e02fc1f89e2fe6/janrain-python-api-0.4.0.tar.gz" } ] }