{ "info": { "author": "Maxim Kamenkov", "author_email": "mkamenkov@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Programming Language :: Python", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4" ], "description": "python-boxview\n==============\n\nPython client library for `Box View API`_\n\nInstallation\n------------\n\nThe easiest way to install the latest version is by using\npip/easy\\_install to pull it from PyPI:\n\n::\n\n pip install python-boxview\n\nYou may also use Git to clone the repository from Github and install it\nmanually:\n\n::\n\n git clone https://github.com/caxap/python-boxview.git\n python setup.py install\n\nAuthentication\n--------------\n\nBox View API uses token-based authentication. You need create\napplication and generate api token at `Box Developes Portal`_. Then use\nthe token to create instance\n\n.. code:: python\n\n from boxview import boxview\n\n api = boxview.BoxView('')\n\nAlternatively, token can be set by environment variable\n``BOX_VIEW_API_KEY``.\n\nUsage\n-----\n\npython-boxview supports all methods from Box View API. List of methods\nand parameters description can be found `here`_\n\n.. code:: python\n\n import os\n from boxview import boxview\n\n api = boxview.BoxView('')\n\n # upload file to create new document\n doc = api.create_document(file='python-boxview.pdf', name='python-boxview')\n\n # create new document from public url\n doc = api.create_document(url='https://cloud.box.com/shared/static/4qhegqxubg8ox0uj5ys8.pdf')\n\n doc_id = doc['id']\n\n # retrieve existings document\n doc1 = api.get_document(doc_id)\n\n # list all uploaded documents for your api key\n all_docs = api.get_documents(limit=10)\n\n # update name of existing document\n doc1 = api.update_document(doc_id, name='python-boxview')\n\n # check that document ready to view\n bool(api.ready_to_view(doc_id))\n\n # start view session for document\n session = api.create_session(doc_id, duration=300)\n\n ses_id = session['id']\n\n # get link to box viewer\n api.get_session_url(ses_id)\n\n # retrieve original document content to string\n content, mimetype = api.get_document_content_to_string(doc_id)\n len(content)\n\n # retrieve pdf version of document to file\n api.get_document_content_to_file('python-boxview.pdf', doc_id, extension='.pdf')\n os.path.exists('python-boxview.pdf')\n\n # retrieve mimetype of original document content\n mimetype = api.get_document_content_mimetype(doc_id)\n\n # create webhook\n api.create_webhook('http://example.com/my-webhook')\n\n # create S3 storage profile\n api.create_storage_profile('S3', 'super-awesome-bucket', 'AKIAIOSFODNN7EXAMPLE', 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY')\n\n # and delete document\n api.delete_document(doc_id)\n\nDealing with Rate Limiting\n--------------------------\n\n.. code:: python\n\n import time\n from boxview import boxview\n\n api = boxview.BoxView('')\n\n document_id = '2da6cf9261824fb0a4fe532f94d14625'\n retry, max_retry = 0, 3\n while True:\n try:\n api.get_thumbnail_to_file('thumbnail_100x100.png', document_id, 100, 100)\n break # ok, thumbnail saved\n except boxview.RetryAfter as e:\n retry += 1\n if retry <= max_retry:\n time.sleep(e.seconds) # waiting for next call\n else:\n raise # failed after `max_retry` attempts, exit with exception\n\nLicense\n-------\n\nThe MIT License (MIT)\n\nContributed by `Maxim Kamenkov`_\n\n.. _Box View API: https://box-view.readme.io/\n.. _Box Developes Portal: https://app.box.com/developers/services\n.. _here: https://box-view.readme.io/\n.. _Maxim Kamenkov: https://github.com/caxap/", "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/caxap/python-boxview", "keywords": null, "license": "MIT", "maintainer": null, "maintainer_email": null, "name": "python-boxview", "package_url": "https://pypi.org/project/python-boxview/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/python-boxview/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/caxap/python-boxview" }, "release_url": "https://pypi.org/project/python-boxview/1.2.2/", "requires_dist": null, "requires_python": null, "summary": "Python client library for Box View API", "version": "1.2.2" }, "last_serial": 1791718, "releases": { "1.0.1": [ { "comment_text": "", "digests": { "md5": "c7a168020a78bb2bf80c2947a401cc8b", "sha256": "b563feefbff1f018fd6c6716659c1113293a6823ac9da1822b392e7e2843f444" }, "downloads": -1, "filename": "python-boxview-1.0.1.tar.gz", "has_sig": false, "md5_digest": "c7a168020a78bb2bf80c2947a401cc8b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3992, "upload_time": "2013-11-23T11:11:21", "url": "https://files.pythonhosted.org/packages/85/71/2a9e63cc212ad1e414fb93a5bea9a0a50fae6b1227e4360e9c9f9b708e87/python-boxview-1.0.1.tar.gz" } ], "1.0.2": [ { "comment_text": "", "digests": { "md5": "45ec383317b7931736cdf26f001120e5", "sha256": "3082da272f6e105b3f474b2ad2b7b3d4b6dbb419a81eeb0892d5d456a49a2275" }, "downloads": -1, "filename": "python-boxview-1.0.2.tar.gz", "has_sig": false, "md5_digest": "45ec383317b7931736cdf26f001120e5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4033, "upload_time": "2013-11-25T16:30:52", "url": "https://files.pythonhosted.org/packages/81/7c/7f8b3f2f7a27c9d2432681e713cda240a3f8b197b409db1a55b6be1fc16a/python-boxview-1.0.2.tar.gz" } ], "1.0.3": [ { "comment_text": "", "digests": { "md5": "e83cea51b92c8338cc2fe3b99c87a2ee", "sha256": "3486407880bb7c9c14ca96f0628496b032b00b10b35991520c77ed68c2597436" }, "downloads": -1, "filename": "python-boxview-1.0.3.tar.gz", "has_sig": false, "md5_digest": "e83cea51b92c8338cc2fe3b99c87a2ee", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4125, "upload_time": "2013-11-26T19:48:20", "url": "https://files.pythonhosted.org/packages/9c/23/a6f1c6073ca1a2e6d6131aa00129940d9057a79c4d6e1982aa45f31c33e7/python-boxview-1.0.3.tar.gz" } ], "1.1.0beta1": [ { "comment_text": "", "digests": { "md5": "d7704fc112bd683e7f573b1e09bb61bb", "sha256": "765795e87f8709dd640a3bf2768fd1ef17deb3ab99304e6a7d8452ff999402ac" }, "downloads": -1, "filename": "python-boxview-1.1.0beta1.tar.gz", "has_sig": false, "md5_digest": "d7704fc112bd683e7f573b1e09bb61bb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3960, "upload_time": "2014-10-28T16:58:45", "url": "https://files.pythonhosted.org/packages/e8/e0/e9a90aea30b572bf107a3a98d637519794eb423b1cc63e799c9864c25b15/python-boxview-1.1.0beta1.tar.gz" } ], "1.1.1beta1": [ { "comment_text": "", "digests": { "md5": "e6965510cc170ac0d9a410cfb0b01859", "sha256": "bcb3b65d680998e2f48d5d5bf0d71f99521d95950b411ac0e2bc78697bf2e09f" }, "downloads": -1, "filename": "python-boxview-1.1.1beta1.tar.gz", "has_sig": false, "md5_digest": "e6965510cc170ac0d9a410cfb0b01859", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4225, "upload_time": "2014-11-01T00:03:07", "url": "https://files.pythonhosted.org/packages/69/e5/9f43a6e4db7eae7514a6f139c3c1849f46a5b11b7c85cb5f1b312deb93b1/python-boxview-1.1.1beta1.tar.gz" } ], "1.1.2beta1": [ { "comment_text": "", "digests": { "md5": "6082914c564881107b4c67eca74dc659", "sha256": "7c784492d938cd3d7a9b949941ebd2a1f3306f20e5da57d0d07d7ae88a357f85" }, "downloads": -1, "filename": "python-boxview-1.1.2beta1.tar.gz", "has_sig": false, "md5_digest": "6082914c564881107b4c67eca74dc659", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4228, "upload_time": "2015-01-05T20:28:04", "url": "https://files.pythonhosted.org/packages/b5/c5/bd95d64e1347faba4a5f6415b84e2a11a23339090a311a745eda7013b8c2/python-boxview-1.1.2beta1.tar.gz" } ], "1.1.3beta1": [ { "comment_text": "", "digests": { "md5": "43ed691a7c4590711ee7f5d047cc22d2", "sha256": "5cae42d7ccca129bbda937de5c29477cd8203b9522ba1bef6a2a0abacd5aeb72" }, "downloads": -1, "filename": "python-boxview-1.1.3beta1.tar.gz", "has_sig": false, "md5_digest": "43ed691a7c4590711ee7f5d047cc22d2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4237, "upload_time": "2015-01-11T22:26:36", "url": "https://files.pythonhosted.org/packages/6c/a4/f90d91bcff45d818be982ac2c8ea6b4bd6038711790856430d36da407acf/python-boxview-1.1.3beta1.tar.gz" } ], "1.2.0": [ { "comment_text": "", "digests": { "md5": "f86b9dad4a71c3b5cde5eb1439a16eda", "sha256": "23661b7112ef6f71701d0c5b47c15ef339120d2a4b0876e8298034ab9205b42e" }, "downloads": -1, "filename": "python-boxview-1.2.0.tar.gz", "has_sig": false, "md5_digest": "f86b9dad4a71c3b5cde5eb1439a16eda", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5845, "upload_time": "2015-10-24T06:44:37", "url": "https://files.pythonhosted.org/packages/2b/5e/0daf7693bf8e56778853a3141b17789207c7ab7954db6c49fb26eae82325/python-boxview-1.2.0.tar.gz" } ], "1.2.1": [ { "comment_text": "", "digests": { "md5": "9be240650768bdf1322238ab9b888f4e", "sha256": "9d9a13fb3e409859f53a4647081dec4c62fcf94da280c0b7ef62182e09e4461b" }, "downloads": -1, "filename": "python-boxview-1.2.1.tar.gz", "has_sig": false, "md5_digest": "9be240650768bdf1322238ab9b888f4e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8932, "upload_time": "2015-10-24T06:49:23", "url": "https://files.pythonhosted.org/packages/82/eb/acabe5e53b1fad101b97360c1e1ed688023ebba7605245a7a1c8caca9a83/python-boxview-1.2.1.tar.gz" } ], "1.2.2": [ { "comment_text": "", "digests": { "md5": "be4f5703ac15e271c5cbdad32c8176b1", "sha256": "ce5d6364643769a49d5128f2c0292215dbb1da6a747957a2cde5ca50572f6eb7" }, "downloads": -1, "filename": "python-boxview-1.2.2.tar.gz", "has_sig": false, "md5_digest": "be4f5703ac15e271c5cbdad32c8176b1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8975, "upload_time": "2015-10-29T11:16:35", "url": "https://files.pythonhosted.org/packages/d6/bb/adfd62f49104b643c2f45e0b944ae7384ceef7286df2441d0d0f437d3919/python-boxview-1.2.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "be4f5703ac15e271c5cbdad32c8176b1", "sha256": "ce5d6364643769a49d5128f2c0292215dbb1da6a747957a2cde5ca50572f6eb7" }, "downloads": -1, "filename": "python-boxview-1.2.2.tar.gz", "has_sig": false, "md5_digest": "be4f5703ac15e271c5cbdad32c8176b1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8975, "upload_time": "2015-10-29T11:16:35", "url": "https://files.pythonhosted.org/packages/d6/bb/adfd62f49104b643c2f45e0b944ae7384ceef7286df2441d0d0f437d3919/python-boxview-1.2.2.tar.gz" } ] }