{
    "info": {
        "author": "Katie House",
        "author_email": "katiehouse3@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "License :: OSI Approved :: MIT License",
            "Operating System :: OS Independent",
            "Programming Language :: Python :: 3"
        ],
        "description": "# Zoltpy\nA python module that interfaces with Zoltar https://github.com/reichlab/forecast-repository\n\n## Installation requirements\n- [python 3.6](https://www.python.org/downloads/release/python-360/) \n- [pipenv](https://pipenv.readthedocs.io/en/latest/) for managing packages - see Pipfile\n- [click](https://click.palletsprojects.com/en/7.x/) - for the demo application's handling of args\n- [pandas](https://pandas.pydata.org/) - for use of dataframe function\n- [requests](http://docs.python-requests.org/en/v2.7.0/user/install/)\n- [numpy](https://pypi.org/project/numpy/)\n\n## Installation\nZoltpy is hosted on the Python Package Index (pypi.org), a repository for Python modules https://pypi.org/project/zoltpy/. \n\nInstall Zoltpy with the following command:\n```\npip install zoltpy\n```\n\n## One-time configuration\nUsers must add their Zoltar username and password to environment variables on their machine before using this module. \n\n### For Mac/Unix\n```\ncd ~\nnano .bash_profile\n```\nAdd the following to your bash_profile:\n```\nexport Z_USERNAME=<your zoltar username>\nexport Z_PASSWORD=<your zoltar password>\n```\nAfter you are finished, press `Ctrl` + `O`, `Enter`, and `Ctrl` + `X` to save and quit.\n\nThen enter the command:\n```\nsource ~/.bash_profile\n```\nTo ensure your environment variable is configured properly, run this command and check for Z_USERNAME and Z_PASSWORD:\n```\nprintenv\n```\n\n### For PC\nIn the command prompt, run the following commands:\n```\nset Z_USERNAME=\"<your zoltar username>\"\nset Z_PASSWORD=\"<your zoltar password>\"\n```\n\n## Usage\nZoltpy is a python module that communicates with Zoltar, the Reich Lab's forecast repository. To import the Zoltpy functions, run the following command after installing the package:\n```\nimport zoltpy as zp\n```\n\n### Zoltpy currently has 5 Key Functions:\n1) [print_projects()](#print-project-names) - Print project names\n2) [print_models(`project_name`)](#print-model-names) - Print model names for a specified project\n3) [delete_forecast(`project_name`, `model_name`, `timezero_date`)](#delete-forecast) - Deletes a forecast from Zoltar\n4) [upload_forecast(`project_name`, `model_name`, `timezero_date`, `forecast_csv_file`)](#Upload-a-Forecast) - Upload a forecast to Zoltar\n5) [forecast_to_dataframe(`project_name`, `model_name`, `timezero_date`)](#Return-Forecast-as-a-Pandas-Dataframe) - Returns forecast as a Pandas Dataframe\n\n\n#### Print Project Names\nThis fuction returns the project names that you have authorization to view in Zoltar.\n```\nzp.print_projects()\n```\n\n#### Print Model Names\nGiven a project, this function prints the models in that project.\n```\nzp.print_models(project_name = 'My Project')\n```\n\n#### Delete a Forecast\nDeletes a single forecast for a specified model and timezero.\n```\nzp.delete_forecast(project_name='My Project', model_name='My Model', timezero_date='YYYYMMDD')\n```\nExample:\n```\nzp.delete_forecast('Impetus Province Forecasts','gam_lag1_tops3','20181203')\n```\n\n#### Upload a Forecast\n```\nzp.upload_forecast(project_name='My Project', model_name='My Model', timezero_date='YYYYMMDD', 'C:\\\\Users\\\\house\\\\Desktop\\\\20181203-gam_lag1_tops3-20190114.csv')\n```\n\nExample:\n```\nzp.upload_forecast('Impetus Province Forecasts','gam_lag1_tops3','20181203','C:\\\\Users\\\\house\\\\Desktop\\\\20181203-gam_lag1_tops3-20190114.csv')\n```\n\n#### Return Forecast as a Pandas Dataframe\nExample:\n```\nzp.forecast_to_dataframe('Impetus Province Forecasts','gam_lag1_tops3','20181203')\n```\n",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/reichlab/zoltpy",
        "keywords": "",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "zoltpy",
        "package_url": "https://pypi.org/project/zoltpy/",
        "platform": "",
        "project_url": "https://pypi.org/project/zoltpy/",
        "project_urls": {
            "Homepage": "https://github.com/reichlab/zoltpy"
        },
        "release_url": "https://pypi.org/project/zoltpy/0.0.4.dev0/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "A package of Reich Lab Zoltar utility functions.",
        "version": "0.0.4.dev0"
    },
    "last_serial": 5209145,
    "releases": {
        "0.0.1.dev0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "46761eb5d16b4f98fa817e432a0b7c15",
                    "sha256": "2442689e814afaed31fe4d0642459c58165ff0f6ed8040811943206b68a226c9"
                },
                "downloads": -1,
                "filename": "zoltpy-0.0.1.dev0.tar.gz",
                "has_sig": false,
                "md5_digest": "46761eb5d16b4f98fa817e432a0b7c15",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 3373,
                "upload_time": "2019-03-11T15:10:26",
                "url": "https://files.pythonhosted.org/packages/8a/00/da1a509ed79e5ad2d1692204fbfca1dc8748981ae063bda66d5e32a7a295/zoltpy-0.0.1.dev0.tar.gz"
            }
        ],
        "0.0.2.dev0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "b1a9354b3e7610577debc757036f927e",
                    "sha256": "fa52b16fb5890af9720a849127664be3dd27cd330223d93ca95cdc066849123b"
                },
                "downloads": -1,
                "filename": "zoltpy-0.0.2.dev0.tar.gz",
                "has_sig": false,
                "md5_digest": "b1a9354b3e7610577debc757036f927e",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4512,
                "upload_time": "2019-03-27T15:21:13",
                "url": "https://files.pythonhosted.org/packages/a0/a1/413029097f52a4c50356d93ea0b40b8b53681470b31ec7be463ac210f448/zoltpy-0.0.2.dev0.tar.gz"
            }
        ],
        "0.0.3.dev0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "686840e06072a6e9ff436a3754d792bd",
                    "sha256": "92363639e32fe725bdf71fb7f7786df67beeed01917d31011301c36c3e4ae7a9"
                },
                "downloads": -1,
                "filename": "zoltpy-0.0.3.dev0.tar.gz",
                "has_sig": false,
                "md5_digest": "686840e06072a6e9ff436a3754d792bd",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6155,
                "upload_time": "2019-04-08T12:03:37",
                "url": "https://files.pythonhosted.org/packages/26/d6/ec594d430bb0db3bc80f61f91df06f6cbcdc7084a3886a459236ea2029a0/zoltpy-0.0.3.dev0.tar.gz"
            }
        ],
        "0.0.4.dev0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "59e646442875e738fb5d36d2f421ddde",
                    "sha256": "3331102a1157b07046ed64397901033aa7981d64c425a9ceeb128b20e691bc9b"
                },
                "downloads": -1,
                "filename": "zoltpy-0.0.4.dev0.tar.gz",
                "has_sig": false,
                "md5_digest": "59e646442875e738fb5d36d2f421ddde",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6457,
                "upload_time": "2019-04-30T16:26:03",
                "url": "https://files.pythonhosted.org/packages/3b/64/51082b9c68181f86461c4d3d9b12c42e5c2f630662d2b83926be619bebe6/zoltpy-0.0.4.dev0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "59e646442875e738fb5d36d2f421ddde",
                "sha256": "3331102a1157b07046ed64397901033aa7981d64c425a9ceeb128b20e691bc9b"
            },
            "downloads": -1,
            "filename": "zoltpy-0.0.4.dev0.tar.gz",
            "has_sig": false,
            "md5_digest": "59e646442875e738fb5d36d2f421ddde",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 6457,
            "upload_time": "2019-04-30T16:26:03",
            "url": "https://files.pythonhosted.org/packages/3b/64/51082b9c68181f86461c4d3d9b12c42e5c2f630662d2b83926be619bebe6/zoltpy-0.0.4.dev0.tar.gz"
        }
    ]
}