{ "info": { "author": "Joe Drumgoole", "author_email": "joe@joedrumgoole.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: Apache Software License", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: Implementation :: CPython", "Programming Language :: Python :: Implementation :: PyPy" ], "description": "# MongoDB Atlas - A Python API for MongoDB Atlas\n\nThe MongoDB database as a service offering [Atlas](https://www.mongodb.com/cloud/atlas) provides\na complete and well documented [REST API](https://docs.atlas.mongodb.com/api/).\n\n## Installation\n\nThe easiest way to install the `mongodbatlas` is with `pip`.\n\n```shell\n$ pip install mongodbatlas\n```\n\nOnce the installation completes you can confirm it has worked by running\n\n```shell\n$ atlascli -h\nusage: atlascli [-h] [--publickey PUBLICKEY] [--privatekey PRIVATEKEY] [--org]\n [--pause PAUSE_CLUSTER] [--resume RESUME_CLUSTER]\n [--list {projects,clusters}] [--cluster CLUSTER]\n [--project_id PROJECT_DETAIL] [--format {summary,full}]\n [--debug] [--resource RESOURCE] [--itemsperpage ITEMSPERPAGE]\n [--pagenum PAGENUM]\n\noptional arguments:\n -h, --help show this help message and exit\n --publickey PUBLICKEY\n MongoDB Atlas public API key\n --privatekey PRIVATEKEY\n MongoDB Atlas private API key\n...\n```\n\n\nThe Python Atlas API wraps the REST API in a more Pythonic\nAPI based around an ``AtlasAPI`` class. \n\nThe library assumes the existence of two environment variables:\n\n* `ATLAS_PUBLIC_KEY` : The public key value defined by the \n[Atlas programmatic API key](https://docs.atlas.mongodb.com/configure-api-access/#programmatic-api-keys)\n* `ATLAS_PRIVATE_KEY` : The private key defined by the Atlas programmatic API\nkey.\n\nSee the section [below](#how-to-create-an-atlas-api-key) on how to create a programmatic Atlas API key.\n\n## Usage\n\n```python\nfrom mongodbatlas.api import AtlasAPI\n\nao\n\n```\n## How to create an Atlas API Key\nYou can create keys at the Organization level by selecting the access menu item \non the left hand side menu:\n\n![API Start Screen ](https://raw.githubusercontent.com/jdrumgoole/atlasapi/master/images/api-key-screen.png)\n\n\nOnce you create a key you then need to assign it permissions. If you pick the \ndefault youwill have to add this key explicitly to every project that you want \nto manage via the API.\n\n![API Permissions Screen ](https://raw.githubusercontent.com/jdrumgoole/atlasapi/master/images/api-key-permissions.png)\n\nOn the next screen you can collect your API key. You will only get to see it\nonce so please make sure to take a copy.\n\n\n![API Create Key Screen ](https://raw.githubusercontent.com/jdrumgoole/atlasapi/master/images/api-key-create.png)\n\nNot on this screen we obliterate part of the key so it can't been seen. \n\nFinally you need to whitelist any nodes that are going to originate API requests. \n\n![API Create Key Screen ](https://raw.githubusercontent.com/jdrumgoole/atlasapi/master/images/api-key-whitelist.png)\n\nYou are now ready to start using your API key.\n\n## Using your keys\n\nBoth parts of the key required to acc", "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/jdrumgoole/MongoDB-Atlas-API", "keywords": "", "license": "Apache 2.0", "maintainer": "", "maintainer_email": "", "name": "mongodbatlas", "package_url": "https://pypi.org/project/mongodbatlas/", "platform": "", "project_url": "https://pypi.org/project/mongodbatlas/", "project_urls": { "Homepage": "https://github.com/jdrumgoole/MongoDB-Atlas-API" }, "release_url": "https://pypi.org/project/mongodbatlas/0.2.2/", "requires_dist": null, "requires_python": ">=3.6.0", "summary": "Python API to the MongoDB Atlas REST Interface", "version": "0.2.2" }, "last_serial": 5956904, "releases": { "0.1.3": [ { "comment_text": "", "digests": { "md5": "925acc6e6ad9eb47288889253ae5256e", "sha256": "3d9d003b74365f4841193ddd3e881b7ad139d9d022c2d4b9e0cd7ac2848b902a" }, "downloads": -1, "filename": "mongodbatlas-0.1.3.tar.gz", "has_sig": false, "md5_digest": "925acc6e6ad9eb47288889253ae5256e", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6.0", "size": 3881, "upload_time": "2019-10-09T16:20:07", "url": "https://files.pythonhosted.org/packages/52/6a/b5693312c3a56067dbd8497a6c28895e932c0af286c9bbf28872e1baa7e1/mongodbatlas-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "43e80b51c2fbe93bd4bec6078ab044a2", "sha256": "077d8556c99cad1d75f9bed79222b5d168a1839191faba54980046c07ca2520f" }, "downloads": -1, "filename": "mongodbatlas-0.1.4.tar.gz", "has_sig": false, "md5_digest": "43e80b51c2fbe93bd4bec6078ab044a2", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6.0", "size": 4256, "upload_time": "2019-10-09T16:29:00", "url": "https://files.pythonhosted.org/packages/15/3b/12195039041470bbb319b81974458f47852ba4f4bb5875ea03b260f6f828/mongodbatlas-0.1.4.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "6a8e94c96b4ef7985b25105f0d579c79", "sha256": "f68d87a0922a2e6e1c3a76509118a906ac66a0397757a557936d6d91fc0f3c86" }, "downloads": -1, "filename": "mongodbatlas-0.1.5.tar.gz", "has_sig": false, "md5_digest": "6a8e94c96b4ef7985b25105f0d579c79", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6.0", "size": 11582, "upload_time": "2019-10-10T12:47:45", "url": "https://files.pythonhosted.org/packages/f7/b2/912d807933f1a05482f32b9311c4ab769832bfeb5c9f243015750ea11f91/mongodbatlas-0.1.5.tar.gz" } ], "0.1.6": [ { "comment_text": "", "digests": { "md5": "a7f570887afa0d99c45d0d197718e9c4", "sha256": "f7f55999ea0bb6c77f3599d246c64d4ec8df5f74a889c9668c0bf94288598136" }, "downloads": -1, "filename": "mongodbatlas-0.1.6.tar.gz", "has_sig": false, "md5_digest": "a7f570887afa0d99c45d0d197718e9c4", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6.0", "size": 11489, "upload_time": "2019-10-10T13:07:41", "url": "https://files.pythonhosted.org/packages/8c/fd/bd1d5f3925e7205ea4284bf36d08a7215e7b360d140f93bb08d42dfb102f/mongodbatlas-0.1.6.tar.gz" } ], "0.1.7": [ { "comment_text": "", "digests": { "md5": "06afb47f5cee6d692b29eac8dd8cf337", "sha256": "39c82586d7bb78015acb519aeab7fee108aefe5d0237a6e957a0ff2df2f612a5" }, "downloads": -1, "filename": "mongodbatlas-0.1.7.tar.gz", "has_sig": false, "md5_digest": "06afb47f5cee6d692b29eac8dd8cf337", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6.0", "size": 11489, "upload_time": "2019-10-10T13:12:18", "url": "https://files.pythonhosted.org/packages/b9/b6/29518c2184f420fcb9fe5366d8d7003af2e0da6769b6ae9626e46f852a9c/mongodbatlas-0.1.7.tar.gz" } ], "0.1.8": [ { "comment_text": "", "digests": { "md5": "fb6717288111257d2f15cadcdce373f6", "sha256": "a51b9907d349c9ff1e13c9a4519a1c31a20cba96b969d4b02e0d8624b135e145" }, "downloads": -1, "filename": "mongodbatlas-0.1.8.tar.gz", "has_sig": false, "md5_digest": "fb6717288111257d2f15cadcdce373f6", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6.0", "size": 11452, "upload_time": "2019-10-10T13:31:32", "url": "https://files.pythonhosted.org/packages/47/cf/4a7962a8af69691fb0ba8b121b2b2348aee96b0b46b9bdc123701ac1ed59/mongodbatlas-0.1.8.tar.gz" } ], "0.1.9": [ { "comment_text": "", "digests": { "md5": "f586a4e8e137a68cb39c27fb6486e8b6", "sha256": "93714827c0ae4c5e583de0477fd4f87c1060edc4707ab18589021d9d48dba69f" }, "downloads": -1, "filename": "mongodbatlas-0.1.9.tar.gz", "has_sig": false, "md5_digest": "f586a4e8e137a68cb39c27fb6486e8b6", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6.0", "size": 11469, "upload_time": "2019-10-10T17:14:54", "url": "https://files.pythonhosted.org/packages/58/59/77da761ba3b9c21835cff681f63b0fb4c8b92a3530d7e7c3d1f6c17f0845/mongodbatlas-0.1.9.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "4f4eb4f6450555f9c55eadb4929dee0a", "sha256": "15db264c4aefcd88e96e793a57ecad3d49eae22b3c41af5ec7cc2156db5b8dc5" }, "downloads": -1, "filename": "mongodbatlas-0.2.1.tar.gz", "has_sig": false, "md5_digest": "4f4eb4f6450555f9c55eadb4929dee0a", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6.0", "size": 11261, "upload_time": "2019-10-10T19:01:20", "url": "https://files.pythonhosted.org/packages/3b/75/514ff3a5634ce100d6f16010d5416169ecac5b4fa26b8444edac095030aa/mongodbatlas-0.2.1.tar.gz" } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "90deac24be75c3e2d3bf49fa0b43d14f", "sha256": "054519c6d85746b37190cf7b526ec0768f610a793b503f862b4a16139a4e1258" }, "downloads": -1, "filename": "mongodbatlas-0.2.2.tar.gz", "has_sig": false, "md5_digest": "90deac24be75c3e2d3bf49fa0b43d14f", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6.0", "size": 11272, "upload_time": "2019-10-10T20:46:52", "url": "https://files.pythonhosted.org/packages/49/7c/239ead8da243428aa052d97fed46b85f7ed8009a40b0abfcd0230be755a3/mongodbatlas-0.2.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "90deac24be75c3e2d3bf49fa0b43d14f", "sha256": "054519c6d85746b37190cf7b526ec0768f610a793b503f862b4a16139a4e1258" }, "downloads": -1, "filename": "mongodbatlas-0.2.2.tar.gz", "has_sig": false, "md5_digest": "90deac24be75c3e2d3bf49fa0b43d14f", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6.0", "size": 11272, "upload_time": "2019-10-10T20:46:52", "url": "https://files.pythonhosted.org/packages/49/7c/239ead8da243428aa052d97fed46b85f7ed8009a40b0abfcd0230be755a3/mongodbatlas-0.2.2.tar.gz" } ] }