{ "info": { "author": "Chris von Csefalvay", "author_email": "chris@chrisvoncsefalvay.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Environment :: Console", "Intended Audience :: Developers", "Intended Audience :: Financial and Insurance Industry", "License :: OSI Approved :: Apache Software License", "Operating System :: OS Independent", "Topic :: Office/Business :: Financial" ], "description": "# pyrst\n\nThe Python wrapper to the Birst API.\n- No token repetition: once you obtain a token, Pyrst will manage it for you\nuntil you tell it to stop.\n- Super easy querying\n- Even easier output using handlers\n\n# How to install\n\nUntil we release this project to PyPI, the best way to install is:\n\n```\ngit clone --recursive https://github.com/rbonedata/pyrst.git\npython setup.py install\n```\n\nOn OS X and Linux, unless you're installing in a venv, you might need to run\nthe install scripts as a privileged user (`sudo`).\n\n# How to use\n\n## General usage\n\n### Importing the client and create a client object\n\nYou can store configuration in a config file - a template of the config file is\nunder the `pyrst` folder. You can name the config file anything you want. To\nkeep the password somewhat safe, use `base64` encoding and set the\n`password_is_encrypted` flag to `True`.\n\n```python\nfrom pyrst.client import BirstClient\n\nclient = BirstClient(configfile='pyrst/config.yaml')\n```\n\nAlternatively, you can manually create the client:\n\n```python\nfrom pyrst.client import BirstClient\n\nclient = BirstClient(user = \"MyUsername\",\n password = \"MyPassword\")\n```\n\n### Login\n\n```python\nclient.login()\n```\n\n```\nYou have been successfully logged in, DOMAIN\\Username.\nYour token is: 9b4081fa4b9f3d8d15f77271b7e83902\n```\n\n### Logout\n\nOnce you're done, simply use `client.logout()` to log out.\n\n\n## Querying\n\nTo query a space, use `executequery()`. Before querying, it makes sense to\nimport the handler that you want to use to display the data, if any:\n\n```python\nfrom pyrst.handlers import DfHandler\n```\n\nNow you can use it in your query:\n\n```python\ntable = executequery(space = \"12345678-abcd-9012-efab-345678901234\",\n query = \"SELECT [# sales_total] from [ALL]\",\n handler = DfHandler)\n```\n\n\n# Development roadmap\n\nThe current functionality doesn't do much beyond querying, but we'll be\nsteadily developing `Pyrst`'s capabilities. In particular, multipart querying\nand more handlers will be implemented soon.\n\nCurrent priorities are:\n- better handlers,\n- better query handling,\n- JSON output,\n- tests,\n- documentation,\n- more functionality.\n\n# Credits\n\nWritten by Chris von Csefalvay with the generous support of RB.", "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/rbonedata/pyrst", "keywords": "BI,business intelligence,api,birst", "license": "Apache 2.0", "maintainer": null, "maintainer_email": null, "name": "pyrst", "package_url": "https://pypi.org/project/pyrst/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/pyrst/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/rbonedata/pyrst" }, "release_url": "https://pypi.org/project/pyrst/0.6.1/", "requires_dist": null, "requires_python": null, "summary": "Pyrst is a Python client for Birst's API.", "version": "0.6.1" }, "last_serial": 1452499, "releases": { "0.5.1": [ { "comment_text": "", "digests": { "md5": "f2b4eb9f3563643f808338ff6c5e6807", "sha256": "1e94be88e39317fbe927edf53c5167583c504e9c36d455da7edf2ce7a8843849" }, "downloads": -1, "filename": "pyrst-0.5.1.tar.gz", "has_sig": false, "md5_digest": "f2b4eb9f3563643f808338ff6c5e6807", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5492, "upload_time": "2015-02-22T15:14:11", "url": "https://files.pythonhosted.org/packages/fe/dd/89e129f54564ae9bdb4307668069d2fc0c67f424ee43cbab9782eedbdef8/pyrst-0.5.1.tar.gz" } ], "0.5.3": [ { "comment_text": "", "digests": { "md5": "b14439a88cd84f3e3d58b409232ebede", "sha256": "893cbed0bd160cdc244da00e4679c65311c0b3063ac2d5b5767921794bec281b" }, "downloads": -1, "filename": "pyrst-0.5.3.tar.gz", "has_sig": false, "md5_digest": "b14439a88cd84f3e3d58b409232ebede", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5495, "upload_time": "2015-02-26T14:19:20", "url": "https://files.pythonhosted.org/packages/0c/55/8c875aaaaa6c3ae53722bbc888328a2c76369c730d723b1e972ba65d0f37/pyrst-0.5.3.tar.gz" } ], "0.5.9": [ { "comment_text": "", "digests": { "md5": "7f9858186fcace180cc33d1d2ed36c14", "sha256": "eab82ded88d31cf0d8fcfeb7de963a522b26a491de823fe1104e755a53785642" }, "downloads": -1, "filename": "pyrst-0.5.9.tar.gz", "has_sig": false, "md5_digest": "7f9858186fcace180cc33d1d2ed36c14", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5503, "upload_time": "2015-03-02T11:18:45", "url": "https://files.pythonhosted.org/packages/f7/02/3a24a93a8762e33de08dfa293c9e2d2d0a2830db5625f3f49517bdf60fd2/pyrst-0.5.9.tar.gz" } ], "0.6.0": [ { "comment_text": "", "digests": { "md5": "26986a37efa0180aa8fa57ddac9ebe89", "sha256": "74c987be630c6e586d4b5a7e69168160f76ea3dbe9d5984c99ca131027d66897" }, "downloads": -1, "filename": "pyrst-0.6.0.tar.gz", "has_sig": false, "md5_digest": "26986a37efa0180aa8fa57ddac9ebe89", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6557, "upload_time": "2015-03-03T23:46:53", "url": "https://files.pythonhosted.org/packages/ba/1f/c854c784ecabd9ee2c851dabc8579fac4157e70778b06d30af9621a121d1/pyrst-0.6.0.tar.gz" } ], "0.6.1": [ { "comment_text": "", "digests": { "md5": "91b9c4aa8837869b815ede4a070ad17c", "sha256": "4bdf03040da6d898220c1ac75154304f009022ffa6c7a70e0a0b384ce69bb291" }, "downloads": -1, "filename": "pyrst-0.6.1.tar.gz", "has_sig": false, "md5_digest": "91b9c4aa8837869b815ede4a070ad17c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7872, "upload_time": "2015-03-05T09:59:10", "url": "https://files.pythonhosted.org/packages/0b/09/485755d34b60689f1025d0ae1990e3f5250f72b51f3611f02876b23a68ef/pyrst-0.6.1.tar.gz" } ], "0.6.1b": [ { "comment_text": "", "digests": { "md5": "8980030e74bc46ae250925d2bacd7c2a", "sha256": "0d47525b2820db9644493641cf18e63c1374f57a55863fa6bc54ee0efd8cba5c" }, "downloads": -1, "filename": "pyrst-0.6.1b.tar.gz", "has_sig": false, "md5_digest": "8980030e74bc46ae250925d2bacd7c2a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7989, "upload_time": "2015-03-07T23:25:29", "url": "https://files.pythonhosted.org/packages/59/18/16015430a7901cae060a696ab8ace90d7eb0d1757bc0f2cb05e436e9be51/pyrst-0.6.1b.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "91b9c4aa8837869b815ede4a070ad17c", "sha256": "4bdf03040da6d898220c1ac75154304f009022ffa6c7a70e0a0b384ce69bb291" }, "downloads": -1, "filename": "pyrst-0.6.1.tar.gz", "has_sig": false, "md5_digest": "91b9c4aa8837869b815ede4a070ad17c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7872, "upload_time": "2015-03-05T09:59:10", "url": "https://files.pythonhosted.org/packages/0b/09/485755d34b60689f1025d0ae1990e3f5250f72b51f3611f02876b23a68ef/pyrst-0.6.1.tar.gz" } ] }