{
    "info": {
        "author": "Scott Crespo",
        "author_email": "sccrespo@gmail.com",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "# CloeePy-Mongoengine\nMongoengine Plugin for CloeePy\n\nConfigures Mongoengine for use with CloeePy\n\n## Installation\n\n`pip install CloeePy-Mongoengine`\n\n## Configuration\n\n### Configuration Basics\nCloeePy-Mongoengine configuration must be placed under `CloeePy.Plugins.cloeepy_mongoengine` in your config file.\nThe parameters are simply the available Mongoengine connection parameters. For more\ninformation on possible configurations please see [Mongoengine's Documentation](https://mongoengine-odm.readthedocs.io/guide/connecting.html)\n\n```\nCloeePy:\n  ...\n  Plugins:\n    cloeepy_mongoengine:\n      alias: default\n      host: \"localhost\"\n      port: 27017\n      name: myDatabase\n      username: admin\n      password: secret\n      authentication_source: admin\n      authentication_mechanism: SCRAM-SHA-1\n      maxPoolSize: 100\n```\n\n### Customize Plugin Namespace\n\nBy default, your mongo connection is available on the CloeePy application context as\n`app.mongoengine`. Meaning, you do have access to the underlying PyMongo Connection\ninstance, but you should not need to use this directly.\n\nOptionally you can specify a different namespace by which you access\nthe mongo connection via `pluginNamespace`.\n\n```\n...\nPlugins:\n  cloeepy_mongoengine:\n    pluginNamespace: customMongoengineNS\n    alias: default\n    host: \"localhost\"\n    port: 27017\n    name: myDatabase\n    username: admin\n    password: secret\n    authentication_source: admin\n    authentication_mechanism: SCRAM-SHA-1\n    maxPoolSize: 100\n```\n\nThen, you would access your mongo connection on the application context like so:\n\n```\napp = CloeePy()\nresult = app.customMongoNS.admin.command(\"isMaster\")\napp.log.info(result)\n```\n\n### Optional Environment Variables\n\nIt's best practice NOT to store sensitive data, such as database usernames and passwords,\nin plain-text configuration files. Thus, CloeePy-Mongoengine supports configuring your mongo username\nand password via environment variables.\n\nYou need to set the following:\n\n- Username: `CLOEEPY_MONGOENGINE_USERNAME`\n- Password: `CLOEEPY_MONGOENGINE_PASSWORD`\n\nBy doing so, you can omit `username` and `password` in your configuration file.\n\n\n## Usage\nSee [Mongoengine's Documentation](https://mongoengine-odm.readthedocs.io/guide/connecting.html)\nfor usage instructions.\n",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/cloeeai/CloeePy-Mongoengine",
        "keywords": "mini framework cloee cloeepy mongo mongodb mongoengine",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "CloeePy-Mongoengine",
        "package_url": "https://pypi.org/project/CloeePy-Mongoengine/",
        "platform": "",
        "project_url": "https://pypi.org/project/CloeePy-Mongoengine/",
        "project_urls": {
            "Homepage": "https://github.com/cloeeai/CloeePy-Mongoengine"
        },
        "release_url": "https://pypi.org/project/CloeePy-Mongoengine/0.0.0/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "Mongoengine Plugin for CloeePy Framework",
        "version": "0.0.0"
    },
    "last_serial": 3707786,
    "releases": {
        "0.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "94d449313260c9b00153a32b27c0d4b2",
                    "sha256": "700ea97990f663315369b6321dfc499b3d53429d08bfe89f87d940b4691e5c7c"
                },
                "downloads": -1,
                "filename": "CloeePy-Mongoengine-0.0.0.tar.gz",
                "has_sig": false,
                "md5_digest": "94d449313260c9b00153a32b27c0d4b2",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4288,
                "upload_time": "2018-03-26T19:34:23",
                "url": "https://files.pythonhosted.org/packages/db/16/291cb9d497bd18dc7e311053b983987851d7ea7f703133b4bccaa57da3c0/CloeePy-Mongoengine-0.0.0.tar.gz"
            }
        ],
        "0.0.0-rc1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "666d530634ea7fd3b741bff1929f24ac",
                    "sha256": "97a19af8585976cf7d65127e0f62f859b7b55728856231a478f878d9fcd8628a"
                },
                "downloads": -1,
                "filename": "CloeePy-Mongoengine-0.0.0-rc1.tar.gz",
                "has_sig": false,
                "md5_digest": "666d530634ea7fd3b741bff1929f24ac",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4301,
                "upload_time": "2018-03-26T19:11:43",
                "url": "https://files.pythonhosted.org/packages/09/53/525fff4bcfc28fe2530ca1bd44bebed65663c70ae6e5b59346e32e2a0e5f/CloeePy-Mongoengine-0.0.0-rc1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "94d449313260c9b00153a32b27c0d4b2",
                "sha256": "700ea97990f663315369b6321dfc499b3d53429d08bfe89f87d940b4691e5c7c"
            },
            "downloads": -1,
            "filename": "CloeePy-Mongoengine-0.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "94d449313260c9b00153a32b27c0d4b2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 4288,
            "upload_time": "2018-03-26T19:34:23",
            "url": "https://files.pythonhosted.org/packages/db/16/291cb9d497bd18dc7e311053b983987851d7ea7f703133b4bccaa57da3c0/CloeePy-Mongoengine-0.0.0.tar.gz"
        }
    ]
}