{ "info": { "author": "Space Up Tech", "author_email": "info@spaceuptech.com", "bugtrack_url": null, "classifiers": [ "Intended Audience :: Developers", "License :: OSI Approved :: Apache Software License", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.7" ], "description": "# Python Client API for Space Cloud\n\n## Installation\n```bash\n$ pip install space-api-py\n```\n\n## Documentation\nThe complete documentation can be found [here](https://spaceuptech.com/docs).\n\n## Quick Start\n\n### Create Client Instance\n\n```python\nfrom space_api import API, AND, OR, COND\n\napi = API('demo-project', 'localhost:8081')\n\n# For MongoDB\ndb = api.mongo()\n\n# For PostgresQL\ndb = api.postgres()\n\n# For MySQL\ndb = api.my_sql()\n```\n**Note: Multiple databases may be used simultaneously.**\n\n### Insert a document into the database\n```python\nresponse = db.insert('books').doc({\"name\": \"MyBook\", \"author\": \"John Doe\"}).apply()\nif response.status == 200:\n # Record successfully inserted\n print(\"Success\")\nelse:\n # An error occurred\n print(response.error)\n```\n\n### Query documents in database\n```python\nresponse = db.get('books').sort('-author').apply()\nif response.status == 200:\n # We got some result\n print(response.result)\nelse:\n # An error occurred\n print(response.error)\n```\n\n### Update documents in database\n```python\nresponse = db.update_one('books').where(COND(\"author\", \"==\", \"some_author\")).set({\"author\": \"myself\"}).apply()\nif response.status == 200:\n # Record successfully updated\n print(\"Success\")\nelse:\n # An error occurred\n print(response.error)\n```\n\n### Delete documents in database\n```python\nresponse = db.delete('books').where(COND('name', '!=', 'Book_name')).apply()\nif response.status == 200:\n # Record successfully deleted\n print(\"Success\")\nelse:\n # An error occurred\n print(response.error)\n```\n\n### Batch Multiple Requests in database\n```python\nb = db.begin_batch()\nb.add(db.insert('books').doc({\"name\": \"MyBook\", \"author\": \"John Doe\"}))\nb.add(db.insert('books').docs([{\"name\": \"BookName\"}, {\"name\": \"BookName\"}]))\nb.add(db.delete('books').where(COND('name', '!=', 'Book_name')))\nresponse = b.apply()\nif response.status == 200:\n # Record successfully made the changes\n print(\"Success\")\nelse:\n # An error occurred\n print(response.error)\n```\n\n### Call functions directly (Function as a Service) \n```python\nresponse = api.call('test_engine', 'test_func', 'params')\nprint(response)\n```\n\n### User Management - Sign In \n```python\nresponse = db.sign_in(\"user_email\", \"user_password\")\nif response.status == 200:\n print(response.result)\nelse:\n print(response.error)\n```\n\n### User Management - Sign Up \n```python\nresponse = db.sign_up(\"user_email\", \"user_name\", \"user_password\", \"user_role\")\nif response.status == 200:\n print(response.result)\nelse:\n print(response.error)\n```\n\n### User Management - View Profile \n```python\nresponse = db.profile(\"user_id\")\nif response.status == 200:\n print(response.result)\nelse:\n print(response.error)\n```\n\n### User Management - View All Profiles \n```python\nresponse = db.profiles()\nif response.status == 200:\n print(response.result)\nelse:\n print(response.error)\n```\n\n### User Management - Edit Profile \n```python\nresponse = db.edit_profile(\"user_id\", email=\"new_email\", name=\"new_name\", password=\"new_password\")\nif response.status == 200:\n print(response.result)\nelse:\n print(response.error)\n```\n\n## Authors\n[Aliabbas Merchant](https://github.com/AliabbasMerchant) - Initial work\n\n## License\n\nCopyright 2019 Space Up Technologies\n\nLicensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/spaceuptech/space-api-python", "keywords": "", "license": "Apache License, Version 2.0", "maintainer": "", "maintainer_email": "", "name": "space-api-py", "package_url": "https://pypi.org/project/space-api-py/", "platform": "", "project_url": "https://pypi.org/project/space-api-py/", "project_urls": { "Homepage": "https://github.com/spaceuptech/space-api-python" }, "release_url": "https://pypi.org/project/space-api-py/0.9.1/", "requires_dist": null, "requires_python": "", "summary": "Space Cloud Client Python API", "version": "0.9.1" }, "last_serial": 5413949, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "c77dc5dbcab7bdf7056007ff6b508a46", "sha256": "177a8d0bc17d8eeb955ec3f301ce9e83196356a6dd436f5c632cd5591dca59ba" }, "downloads": -1, "filename": "space-api-py-0.1.0.tar.gz", "has_sig": false, "md5_digest": "c77dc5dbcab7bdf7056007ff6b508a46", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15811, "upload_time": "2019-04-16T08:26:18", "url": "https://files.pythonhosted.org/packages/b4/76/fed9deffa44db0de9f16ce94b62e5628523de83d4c2cd29a6486b90ce118/space-api-py-0.1.0.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "c4d19a4ba76a22d4e0d3a77ff5caa5f2", "sha256": "e6ed15e9224eaeec2af6f7939c5d34df81865a3233d9617c1149696fe4e4f598" }, "downloads": -1, "filename": "space-api-py-0.2.0.tar.gz", "has_sig": false, "md5_digest": "c4d19a4ba76a22d4e0d3a77ff5caa5f2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15855, "upload_time": "2019-04-18T10:51:44", "url": "https://files.pythonhosted.org/packages/07/4f/1a018bd057e2d61a2f3d31462453bf39f8bbad0bc21a0e2abd05b8911cf0/space-api-py-0.2.0.tar.gz" } ], "0.9.0": [ { "comment_text": "", "digests": { "md5": "385ccc43267c0fbe226d23eecb4d68d6", "sha256": "c249ce6f4ea96f3ac530a4aa2133b830280b749d3c0ff2513e99c06b111ccc7e" }, "downloads": -1, "filename": "space-api-py-0.9.0.tar.gz", "has_sig": false, "md5_digest": "385ccc43267c0fbe226d23eecb4d68d6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 24098, "upload_time": "2019-06-14T14:09:00", "url": "https://files.pythonhosted.org/packages/31/2e/bb0cb45c6c1f6e5c73f9f6b919bf5203467b0c274af036f0d708d595851d/space-api-py-0.9.0.tar.gz" } ], "0.9.1": [ { "comment_text": "", "digests": { "md5": "20204d16ed5c5841ba0c908e320a11ca", "sha256": "c56c7de1bf26c75eba22ab259597be1843d66c9444449386b6d35018817038ed" }, "downloads": -1, "filename": "space-api-py-0.9.1.tar.gz", "has_sig": false, "md5_digest": "20204d16ed5c5841ba0c908e320a11ca", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 24128, "upload_time": "2019-06-18T08:20:01", "url": "https://files.pythonhosted.org/packages/94/0b/3e707f057f36350245f57fb3fd7e1f1cf2bda41363f1e88d5b750e42df65/space-api-py-0.9.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "20204d16ed5c5841ba0c908e320a11ca", "sha256": "c56c7de1bf26c75eba22ab259597be1843d66c9444449386b6d35018817038ed" }, "downloads": -1, "filename": "space-api-py-0.9.1.tar.gz", "has_sig": false, "md5_digest": "20204d16ed5c5841ba0c908e320a11ca", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 24128, "upload_time": "2019-06-18T08:20:01", "url": "https://files.pythonhosted.org/packages/94/0b/3e707f057f36350245f57fb3fd7e1f1cf2bda41363f1e88d5b750e42df65/space-api-py-0.9.1.tar.gz" } ] }