{
    "info": {
        "author": "Jacob Noble",
        "author_email": "jacob.a.noble@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "License :: OSI Approved :: MIT License",
            "Operating System :: OS Independent",
            "Programming Language :: Python :: 3"
        ],
        "description": "# FundNSF\n---\nPython 3 wrapper for National Science Foundations (NSF) award funding API.\nfundNSF is for performing searches on the National Science Foundations\n(NSF) awards database through their api.\n\n\n[PyPi](https://pypi.org/project/fundNSF/)\n\n[![PyPI version](https://badge.fury.io/py/fundNSF.svg)](https://badge.fury.io/py/fundNSF)\n\n[Github](https://github.com/C-NoBlok/fundNSF)\n\n[NSF API Website](https://www.research.gov/common/webapi/awardapisearch-v1.htm)\n\n## Installation\n\ninstallation through pip is recommended:\n\n    pip install fundNSF\n\n## Example\n\n```python\nfrom fundNSF import FundNSF\n\n>>> nsf = FundNSF()\n>>> nsf.set_fields(abstractText=True) # Data will now include the abstract text\n>>> nsf.fields['abstractText'] = False # Data will now not include abstract text\n>>> nsf.set_params(dateStart='01/01/2018', dateEnd='01/31/2018') # enter date as 'mm/dd/yyyy'\n>>> data = nsf.keyword_search('nano') #returns a Dictionary\n>>> print(data['title'][0])\n\nCAREER:Active Nano-Acoustic Waveguide Matrix to Tackle Signal\nProcessing Limits: Enabling Wideband and Nonreciprocal Integrated\nCommunication Beyond the UHF\n\n>>> award_data = nsf.id_search(data['id'][0])\n>>> print(award_data['fundsObligatedAmt'][0])\n\n500000\n\n>>> data = nsf.get_awards_from('07/17/2019')\n```\n### Used below fields as keywords in set_fields() method to set the fields being retireved.  \n##### Fields retrieved from search by default\n```\n'id': True,\n'title': True,\n'agency' : True,\n'awardeeCity' : True,\n'awardeeName' : True,\n'awardeeStateCode' : True,\n'date' : True,\n'fundsObligatedAmt' : True,\n'piFirstName' : True,\n'piLastName' : True,\n```\n\n##### Other retrievable fields\n```\n'offset' : False\n'awardeeCountryCode' : False,\n'awardeeCounty' : False,\n'awardeeDistrictCode' : False,\n'awardeeZipCode' : False,\n'cfdaNumber' : False,\n'coPDPI' : False,\n'startDate' : False,\n'expDate' : False,\n'estimatedTotalAmt' : False,\n'fundsObligatedAmt' : True,\n'dunsNumber' : False,\n'fundProgramName' : False,\n'parentDunsNumber' : False,\n'pdPIName' : False,\n'perfCity' : False,\n'perfCountryCode' : False,\n'perfCounty' : False,\n'perfDistrictCode' : False,\n'perfLocation' : False,\n'perfStateCode' : False,\n'perfZipCode' : False,\n'poName' : False,\n'primaryProgram' : False,\n'transType' : False,\n'awardee' : False,\n'poPhone' : False,\n'poEmail' : False,\n'awardeeAddress' : False,\n'perfAddress' : False,\n'publicationResearch' : False,\n'publicationConference' : False,\n'fundAgencyCode' : False,\n'awardAgencyCode' : False,\n'projectOutComesReport' : False,\n'abstractText' : False,\n'piMiddeInitial' : False,\n'piLastName' : True,\n'piPhone' : False,\n'piEmail' : False\n```\n\n\n### Search Parameters\nUse as keywords in set_params() method to set search criteria.\nMore search parameters can be found at the [NSF API Website](https://www.research.gov/common/webapi/awardapisearch-v1.htm#request-parameters-notes).\n\n```\n'offset': None,               #Record offset -> page cfdaNumber\n'agency': None,               #'NSF' or 'NASA'\n'dateStart': None,            #Start date for award date to search (ex. 12/31/2012)\n'dateEnd': None,              #End date for award date to search mm/dd/yyyy\n'startDateStart': None,       #Start date for award start date to search\n'startDateEnd' : None,        #End date for award start date to search\n'expDateStart' : None,        #start date for award exp date to search\n'expDateEnd' : None,          #end date for award exp date to search\n'estimatedTotalAmtFrom' : None,\n'estimatedTotalAmtTo' : None,\n'estimatedObligatedAmtFrom' : None,\n'estimatedObligatedAmtTo' : None,\n'awardeeStateCode' : None,\n'awardeeName' : None\n```\n\n\n# Methods:\n\n## get_award_from(start_date, batch_func=None, batch_number=10)\n\n start_date: string in the form of 'mm/dd/yyyy'\n\n batch_func: Function to user for batch operations\n\n batch_number: number of pages (25 awards per page) to perform batch_func on\n\n return: dictionary containing award data\n\n If batch functions is not none function will return True as data will be handled by batch_func\n\n```python\nget_awards_from('12/25/2018')\n```\n\n## keyword_search(*args, batch_func=None, batch_number=10)\ntakes list of keywords to search nsf awards database for\n\n batch_func: Function to user for batch operations\n\n batch_number: number of pages (25 awards per page) to perform batch_func on\n\n If batch functions is not none function will return True as data will be handled by batch_func\n\n```python\nkeyword_search('keyword_1', 'keyword_2')\n```\n\n## id_search(award_id)\nTakes award_id and returns a dictionary containing information on\nthat award using the parameter and field dictionaries\n```python\nid_search(award_id)\n```\n\n## get_report(award_id)\n\nRetrives Project Output Report\n\naward_id: award_id to retrieve report for\n\nreturn: returns string (report) or list of strings (reports) or None\n\n```python\n>>> report = get_report(1052893)\n```\n\n\n## reset()\nResets the fields and params dictionary back to default\n```python\n>>> reset_fields()\n```           \n\n\n## set_fields(self, **kwargs)\nTakes boolean Keyword arguments for fields to be retrieved during the search\n\n```python\n>>> set_fields(abstractText=True)\n```\nvisit: https://www.research.gov/common/webapi/awardapisearch-v1.htm\nfor detailed discription of search fields\n\n\n## set_params(self, **kwargs)\nTakes Keyword arguments for search parameters being used\n```python\n>>> set_params(dateStart='01/01/2017', dateEnd='12/31/2017', awardeeStateCode='WI')\n```\nvisit the [NSF API Website](https://www.research.gov/common/webapi/awardapisearch-v1.htm#request-parameters-notes) for better discription of search parameters\n\n\n## get_fields()\nreturns search fields dictionary\n\n\n## get_params()\nreturns search parameter dictionary\n\n\n",
        "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/C-NoBlok/fundNSF",
        "keywords": "api,National Science Foundation,NSF",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "fundNSF",
        "package_url": "https://pypi.org/project/fundNSF/",
        "platform": "",
        "project_url": "https://pypi.org/project/fundNSF/",
        "project_urls": {
            "Homepage": "https://github.com/C-NoBlok/fundNSF"
        },
        "release_url": "https://pypi.org/project/fundNSF/0.0.334/",
        "requires_dist": [
            "requests (==2.20.0)"
        ],
        "requires_python": "",
        "summary": "Searches National Science Foundation awards database",
        "version": "0.0.334"
    },
    "last_serial": 5591961,
    "releases": {
        "0.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "db597c749a775930900fd2aa38ae2673",
                    "sha256": "941af955c7edd35b306ed948d7fe9322b9d736957f092cafd12187a879107ecc"
                },
                "downloads": -1,
                "filename": "fundNSF-0.0.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "db597c749a775930900fd2aa38ae2673",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 6177,
                "upload_time": "2018-08-31T04:43:13",
                "url": "https://files.pythonhosted.org/packages/c5/e9/555a9f35af7a3685a0161ff4bcaf00fe82c3a9359552001d562c25c5cea2/fundNSF-0.0.1-py3-none-any.whl"
            }
        ],
        "0.0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "cc2e00c0b9f62549540483f8e91e107c",
                    "sha256": "81f122d54aa86194b972996c6d0ed50750b0abe470c853048041c2f8f00ddfb7"
                },
                "downloads": -1,
                "filename": "fundNSF-0.0.2-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "cc2e00c0b9f62549540483f8e91e107c",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 6126,
                "upload_time": "2018-08-31T05:56:15",
                "url": "https://files.pythonhosted.org/packages/8d/82/996de4cf157f3a3e25b7d6fbd0298f8efe5ce1d3cde7a74b6908ba282850/fundNSF-0.0.2-py3-none-any.whl"
            }
        ],
        "0.0.31": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "e106f1c782e3854226a50013635ce273",
                    "sha256": "ee19f5362348bf762f03a35bcbc354e941ab90f91fefe9740b78d4f527e09b83"
                },
                "downloads": -1,
                "filename": "fundNSF-0.0.31-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "e106f1c782e3854226a50013635ce273",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 6111,
                "upload_time": "2018-09-05T05:08:13",
                "url": "https://files.pythonhosted.org/packages/66/c3/567c1efa082796518fdec98a4aeeb657b8f3e8b93b86a3ec6dfe4d807550/fundNSF-0.0.31-py3-none-any.whl"
            }
        ],
        "0.0.32": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "1b16442595451c8b0e297fb3afdf3ead",
                    "sha256": "92f2776340f5a6ce6f8537b5cb6f8a13c43e9e2d16bcb40d75acde0238870ba7"
                },
                "downloads": -1,
                "filename": "fundNSF-0.0.32-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "1b16442595451c8b0e297fb3afdf3ead",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 8523,
                "upload_time": "2018-10-31T04:08:50",
                "url": "https://files.pythonhosted.org/packages/0e/71/9774c4d57977ec1941382de0f41d208e6736b2271338a8a746c36e8ce979/fundNSF-0.0.32-py3-none-any.whl"
            }
        ],
        "0.0.321": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "b5fbb0e935af72defb2d2189e08b2a1d",
                    "sha256": "7d70b75d1110162a126ce0a3acec6545e9fa8fb8a0d75ff6e6f7c1a472299bf4"
                },
                "downloads": -1,
                "filename": "fundNSF-0.0.321-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "b5fbb0e935af72defb2d2189e08b2a1d",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 6905,
                "upload_time": "2018-10-31T04:15:57",
                "url": "https://files.pythonhosted.org/packages/df/f8/1016219f896ac283cdbd0b32a8022fb90b80c4d18c1e3623c5faacf8f9d5/fundNSF-0.0.321-py3-none-any.whl"
            }
        ],
        "0.0.322": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "78b80e3a46841f5ed0441e8e6be2a8e7",
                    "sha256": "efedac0b02ffc2e56cddddd3617c66b8338b9d52db70c744cae3e19077b8aafe"
                },
                "downloads": -1,
                "filename": "fundNSF-0.0.322-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "78b80e3a46841f5ed0441e8e6be2a8e7",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 8420,
                "upload_time": "2019-06-08T03:36:30",
                "url": "https://files.pythonhosted.org/packages/21/99/ee9e08e7174a590bddd29ba0dfa3f6cc69d6641f92372544e524ebdbe1b2/fundNSF-0.0.322-py3-none-any.whl"
            }
        ],
        "0.0.325": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "fdd59d26e9cadf90f635228c31bf76ac",
                    "sha256": "e52fbd661a3cc59a066da36a38db58f0ea072252f7fe2c67a44569895b2cfac4"
                },
                "downloads": -1,
                "filename": "fundNSF-0.0.325-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "fdd59d26e9cadf90f635228c31bf76ac",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 8422,
                "upload_time": "2019-06-08T04:43:21",
                "url": "https://files.pythonhosted.org/packages/d6/65/709bc28528eff10b177cdfa2a31b24b37054ab3adbb6cd80374a807e5c59/fundNSF-0.0.325-py3-none-any.whl"
            }
        ],
        "0.0.326": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "705fa30a74bda7e7a120a89edcc3731e",
                    "sha256": "090f1f8d320459de8ec9a1100bbf30eb5108dde51c19b60a38b9545a42af7393"
                },
                "downloads": -1,
                "filename": "fundNSF-0.0.326-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "705fa30a74bda7e7a120a89edcc3731e",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 8757,
                "upload_time": "2019-06-08T17:27:15",
                "url": "https://files.pythonhosted.org/packages/d9/00/7e3474494dc2637668055987eca495f6cc079fb96447c0a3b965123b3711/fundNSF-0.0.326-py3-none-any.whl"
            }
        ],
        "0.0.327": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "731ceddb5292c6fd0d71ca79e3f61a8b",
                    "sha256": "67fc37838068909b815be82cba4c413f86717a477b432ff5ef4cd9d8a4982c00"
                },
                "downloads": -1,
                "filename": "fundNSF-0.0.327-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "731ceddb5292c6fd0d71ca79e3f61a8b",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 9124,
                "upload_time": "2019-07-18T04:05:39",
                "url": "https://files.pythonhosted.org/packages/30/4e/c2cf29e9c673def03eaef63db0de714a397e90641bf9e6d9d87a525c45a8/fundNSF-0.0.327-py3-none-any.whl"
            }
        ],
        "0.0.328": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "583e1d249b315a799998841996440ced",
                    "sha256": "049ccebe98fc3bae10c6247adc6c811338081cede56714b163afc01280849eaa"
                },
                "downloads": -1,
                "filename": "fundNSF-0.0.328-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "583e1d249b315a799998841996440ced",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 9112,
                "upload_time": "2019-07-22T03:59:45",
                "url": "https://files.pythonhosted.org/packages/fc/e6/40d9f52a14af91b1433842dcacd2b895a139b896780ec398672b1270426d/fundNSF-0.0.328-py3-none-any.whl"
            }
        ],
        "0.0.329": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "8fb43a5d06ee13338a4820587757953d",
                    "sha256": "d8dcfe6faac1f431ef7132fea5ffcc70b6af1bc77264022ffda8a727712053f3"
                },
                "downloads": -1,
                "filename": "fundNSF-0.0.329-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "8fb43a5d06ee13338a4820587757953d",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 9178,
                "upload_time": "2019-07-22T05:45:01",
                "url": "https://files.pythonhosted.org/packages/26/29/2cb52f7d6686b4aa3360a33cb491274a1c375069d613d911dbfefa13fd8f/fundNSF-0.0.329-py3-none-any.whl"
            }
        ],
        "0.0.330": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "f4416617cce17266db1f5aaf7ace5194",
                    "sha256": "b7ef9d8220d5ac09d41b905ca0c466c173a8b745e263892f461ebd39ec8f93f0"
                },
                "downloads": -1,
                "filename": "fundNSF-0.0.330-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "f4416617cce17266db1f5aaf7ace5194",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 9207,
                "upload_time": "2019-07-22T06:02:39",
                "url": "https://files.pythonhosted.org/packages/37/5d/a9f7c376297c7a3db5da5d1c3093f088d715c6b9a0bda51473993c84edb0/fundNSF-0.0.330-py3-none-any.whl"
            }
        ],
        "0.0.331": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "d2cbb04428b89035ec9a458aa6c6a4fc",
                    "sha256": "9c40d275970bfd8c1904206e9700fb43db40df7bb268a145b23ee33d9338b5cf"
                },
                "downloads": -1,
                "filename": "fundNSF-0.0.331-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "d2cbb04428b89035ec9a458aa6c6a4fc",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 9198,
                "upload_time": "2019-07-23T04:36:15",
                "url": "https://files.pythonhosted.org/packages/ac/e8/5f38ad1daf5945f1c0bc97597e97fdc0801b21993f6f42492e4474e93d23/fundNSF-0.0.331-py3-none-any.whl"
            }
        ],
        "0.0.332": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "e27d3f4ac52327a85d41d4612a9ac921",
                    "sha256": "876757388621dd14f05eebb046876f6d52bec80e15d3361cb32dbe93aa63cdee"
                },
                "downloads": -1,
                "filename": "fundNSF-0.0.332-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "e27d3f4ac52327a85d41d4612a9ac921",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 9220,
                "upload_time": "2019-07-23T05:08:25",
                "url": "https://files.pythonhosted.org/packages/35/82/4665bc1341ede550ecd5dedefef7877497dc51634d442dcc3e2ccb1cd57b/fundNSF-0.0.332-py3-none-any.whl"
            }
        ],
        "0.0.333": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "a48b58a11ee9a972258199928df9e04b",
                    "sha256": "9e260753db97d131fed19bb8702cf3d5ff28d17eef20b7e812c35bfba976ea38"
                },
                "downloads": -1,
                "filename": "fundNSF-0.0.333-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "a48b58a11ee9a972258199928df9e04b",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 9242,
                "upload_time": "2019-07-25T11:46:22",
                "url": "https://files.pythonhosted.org/packages/3d/3d/06b5b788ebf07d23138a1e30206674492ab8d1e3e2cfb07f0807a955264e/fundNSF-0.0.333-py3-none-any.whl"
            }
        ],
        "0.0.334": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "4f6acaf20b4610864be5cae6ea45468f",
                    "sha256": "a486fb5753887325f05c286fe7bd08e1afe1eb202a07b38be3aee33002c42fd3"
                },
                "downloads": -1,
                "filename": "fundNSF-0.0.334-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "4f6acaf20b4610864be5cae6ea45468f",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 9245,
                "upload_time": "2019-07-27T05:31:26",
                "url": "https://files.pythonhosted.org/packages/3f/83/70f5f779192309cca0d5ca8bb5b51e61d2037ac2a9c992bf8cea1f1861b4/fundNSF-0.0.334-py3-none-any.whl"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "4f6acaf20b4610864be5cae6ea45468f",
                "sha256": "a486fb5753887325f05c286fe7bd08e1afe1eb202a07b38be3aee33002c42fd3"
            },
            "downloads": -1,
            "filename": "fundNSF-0.0.334-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4f6acaf20b4610864be5cae6ea45468f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 9245,
            "upload_time": "2019-07-27T05:31:26",
            "url": "https://files.pythonhosted.org/packages/3f/83/70f5f779192309cca0d5ca8bb5b51e61d2037ac2a9c992bf8cea1f1861b4/fundNSF-0.0.334-py3-none-any.whl"
        }
    ]
}