{ "info": { "author": "Jogral, L.L.C.", "author_email": "code@jogral.io", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Other Environment", "Intended Audience :: Developers", "Operating System :: MacOS :: MacOS X", "Operating System :: Microsoft :: Windows", "Operating System :: OS Independent", "Operating System :: POSIX", "Programming Language :: Python :: Implementation :: CPython", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "# Jogral Tigris Python SDK\n\n[![Build Status](https://travis-ci.org/jogral/tigris-python-sdk.svg?branch=dev)](https://travis-ci.org/jogral/tigris-python-sdk)\n\nThis is the official Python SDK for [Jogral Tigris](https://jogral.co/product).\nThis SDK will let you execute most of the functionality you would from the API,\nand is an alternative to the stock UI.\n\n## Why use this?\n\nSuppose you want to extend the functionality/features of Tigris, e.g. integrating with your company intranet\nor with a third party service. This SDK is a layer around the REST-like API powering Tigris, leaving you to\nwrite software and not worry about forming your HTTP requests--just use native features!\n\nWe at Jogral are already using this API to build another product: our command line interface for Tigris.\n\n## Installation\n\n```\npip install tigris-python-sdk\n```\n\n## Usage\n\nTo get started:\n\n```python\nfrom tigrissdk.client import Client\n\nclient = Client(username=username, password=password, base_url=base_url)\nprint('My Username: {0}'.format(client.session.user.shortname))\n```\n\nGetting courses:\n\n```python\n# Get all courses\nclient.courses()\n\n# You can use a dict as query params\nclient.courses({'slug': 'test'})\n\n# You can create/retrieve/update, too\n## New course\ncourse_dict = {'title': 'title', ...}\ncourse = client.course(course_dict) # Course is not created yet, but object is.\ncourse = course.save(True) # Now course is added to Tigris, and has an ID.\nprint(course.id)\n\n## Get/edit course\ncourse = client.course({'id': 1}).get()\ncourse.status = 1\nupdated_course = course.save()\n```\n\nMore coming soon.\n\n## Contributing\n\nYou should be able to git started by cloning our repo. We use [`virtualenv`](https://virtualenv.pypa.io/en/stable/)\nand [`pyenv`](https://github.com/pyenv/pyenv) for development. Once you've cloned your repo, go to the repo path and run\n\n\n```\nvirtualenv tigris-sdk-env\npip install -r requirements.txt\n```\n\n\n**NOTE:** You should be sure to have some flavor of Python 3. Due to support officially dropping for Python 2,\nwe do not support Python 2.\n\n### Testing\n\nTest coverage is still largely in progress. However, you can run _existing_\ntest cases by running\n\n```\npytest\n```\n\nor\n\n```\ntox\n```\n\n## Support\n\nDevelopment, support, etc. is managed directly by [Jogral](https://jogral.co).\nIf you want to contact us directly, drop us a line at . We welcome\nyou to open issues directly through GitHub and to use email for questions.\n\n## License\n\nThe Tigris Python SDK is licensed under the Apache License 2.0. See LICENSE for details.\n\n\n## TODO\n\n- Increase test coverage to 100%.\n- Make it clearer when sessions are expired.\n- Create documentation from docstrings.\n- Incorporate upcoming authorization updates to API into SDK.\n- Flesh out roadmap.\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://labs.jogral.co/", "keywords": "jogral tigris learning sdk", "license": "Apache Public License 2.0", "maintainer": "", "maintainer_email": "", "name": "tigris-python-sdk", "package_url": "https://pypi.org/project/tigris-python-sdk/", "platform": "", "project_url": "https://pypi.org/project/tigris-python-sdk/", "project_urls": { "Homepage": "https://labs.jogral.co/" }, "release_url": "https://pypi.org/project/tigris-python-sdk/0.1.7/", "requires_dist": [ "py (>=1.4.29)", "setuptools", "certifi (==2017.7.27.1)", "chardet (==3.0.4)", "idna (==2.6)", "requests (==2.18.4)", "urllib3 (==1.22)", "argparse; python_version==\"2.6\"", "colorama; sys_platform==\"win32\"" ], "requires_python": "", "summary": "The official Python SDK for Jogral Tigris", "version": "0.1.7" }, "last_serial": 3199340, "releases": { "0.1.7": [ { "comment_text": "", "digests": { "md5": "e91988644773bd5a9457b28508a90511", "sha256": "dddb81fc81ab218a2b855361ef5085028b5d0ff1d400d23d2b626f872b2185b4" }, "downloads": -1, "filename": "tigris_python_sdk-0.1.7-py3-none-any.whl", "has_sig": false, "md5_digest": "e91988644773bd5a9457b28508a90511", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 22643, "upload_time": "2017-09-24T23:58:31", "url": "https://files.pythonhosted.org/packages/49/41/9e64fb4cc66c049d13579c319d547b566f88127d24531201ff9b93b0aaf6/tigris_python_sdk-0.1.7-py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "e91988644773bd5a9457b28508a90511", "sha256": "dddb81fc81ab218a2b855361ef5085028b5d0ff1d400d23d2b626f872b2185b4" }, "downloads": -1, "filename": "tigris_python_sdk-0.1.7-py3-none-any.whl", "has_sig": false, "md5_digest": "e91988644773bd5a9457b28508a90511", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 22643, "upload_time": "2017-09-24T23:58:31", "url": "https://files.pythonhosted.org/packages/49/41/9e64fb4cc66c049d13579c319d547b566f88127d24531201ff9b93b0aaf6/tigris_python_sdk-0.1.7-py3-none-any.whl" } ] }