{ "info": { "author": "Gustavo Olegario", "author_email": "gustavo-olegario@hotmail.com", "bugtrack_url": null, "classifiers": [], "description": "# pyusuggest\n\n## Introduction\n\nThis package implements a simple class to integrate with amazing\n[Ubersuggest tool](https://neilpatel.com/ubersuggest/). But what is the Ubersuggest tool anyway?\nIt's a powerfull engine that can give statistics about keywords choosed by the user, taking as\nparams the locale. Unfortanelly, this\ntool doesn't have a native API, so I decide to contribute. Home made.\n\n## Index\n* [Installation](#installation)\n* [Dependencies](#dependencies)\n* [API](#api)\n * [Look up method](#request-data-from-uberssugest)\n * [Get monthly statistics method](#look-up-method)\n * [Download search result in CSV format](#download-results-as-csv)\n* [Documentation](#documentation)\n\n## Installation\n\n pip install pyusuggest\n\n## Dependencies\n\n* `requests`\n* `pytest`\n\n## API\n\n### Instancing the Ubersuggest\n\n from pyusuggest import Ubersuggest\n keyword = 'algorithm'\n ubersuggest = Ubersuggest(keyword)\n\n### Request data from Uberssugest\n\n ubersuggest.look_up()\n\n#### Params\n\nFor instancing `Ubersuggest`:\n\n * `keyword`\n\n - Keyword or prase that will be used in the query of Ubersuggest tool.\n\n * `locale`\n\n - The region that will be used in the query. **Must** follow the padron `en-us`.\n Default locale is `en-us`.\n\nFor use `look_up` method:\n\n * `results`\n\n - Quantity of results that will be returned by the query. The default number is 50.\n\n### Get monthly statistics\nYou can get monthly statistics for the keyword searched and the related searches. The monthly statics show how many times that keyword was searched for each month.\n\n```\nubersuggest.set_keyword('databases')\nubersuggest.look_up()\nubersuggest.get_monthly_statistics()\n```\n\n#### Params\nFor use the `get_monthly_statistics` method:\n\n* `period`: number of months that the user wants to track. If no period is passed as\nargument, every month will be returned.\n\n### Download results as CSV\nYou can also download the results from each keyword in CSV format. It will write\na CSV file in the current working directory with the Search Volume, CPC and\nCompetition info.\n\n```\nubersuggest.set_keyword('java')\nubersuggest.look_up()\nubersuggest.download_results_as_csv()\n```\n\n#### Params\nFor use the `get_monthly_statistics` method:\n\n* No params are required for this method.\n\n## Documentation\n\nOther methods and option params can be checked at documentation.\n\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/Olegario96/pyusuggest", "keywords": "", "license": "BEER-WARE", "maintainer": "", "maintainer_email": "", "name": "pyusuggest", "package_url": "https://pypi.org/project/pyusuggest/", "platform": "", "project_url": "https://pypi.org/project/pyusuggest/", "project_urls": { "Homepage": "https://github.com/Olegario96/pyusuggest" }, "release_url": "https://pypi.org/project/pyusuggest/1.0.5/", "requires_dist": [ "atomicwrites (==1.2.1)", "attrs (==18.2.0)", "certifi (==2018.11.29)", "chardet (==3.0.4)", "idna (==2.8)", "more-itertools (==4.3.0)", "pluggy (==0.8.0)", "py (==1.7.0)", "pytest (==4.0.2)", "requests (==2.21.0)", "six (==1.12.0)", "urllib3 (==1.24.1)" ], "requires_python": "", "summary": "API to integrate Ubersuggest with Python", "version": "1.0.5" }, "last_serial": 4850930, "releases": { "1.0": [ { "comment_text": "", "digests": { "md5": "5bd66f5005f8b65bf607cf2fb4797afb", "sha256": "75e4e15929b9da79ced29cf41d8c5e49595eb13f649f25ebf2755616a2218279" }, "downloads": -1, "filename": "pyusuggest-1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "5bd66f5005f8b65bf607cf2fb4797afb", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4700, "upload_time": "2018-12-19T21:36:22", "url": "https://files.pythonhosted.org/packages/27/b4/f9c2d1a60af57ea7c1573fe42052d1cf4fe490ba080b4311e8e385c571c4/pyusuggest-1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ee38caddc1ca3c543f0719901211a0ed", "sha256": "c1ce77bc9f10e7091ff36accec4b5660317cb3a5702ca1a98c329f8aa96a73d3" }, "downloads": -1, "filename": "pyusuggest-1.0.tar.gz", "has_sig": false, "md5_digest": "ee38caddc1ca3c543f0719901211a0ed", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3805, "upload_time": "2018-12-19T21:36:24", "url": "https://files.pythonhosted.org/packages/bc/bc/ec562d6c45faadafd1d89e1aa87844338b30fe5ba35b82f288abe47e4968/pyusuggest-1.0.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "57f161e68d967a40b074d8d731199977", "sha256": "7b9e10f9fdd60ef82c14eaac3cea91f6a6803a72206712299df169ac6990361d" }, "downloads": -1, "filename": "pyusuggest-1.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "57f161e68d967a40b074d8d731199977", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5429, "upload_time": "2018-12-20T00:12:44", "url": "https://files.pythonhosted.org/packages/10/4f/4e4dfa596ca5c26f9aa9c7bd2109ef1e4d5ef721fe06de282a53c407f5a0/pyusuggest-1.0.1-py3-none-any.whl" } ], "1.0.3.1": [ { "comment_text": "", "digests": { "md5": "4cdaf24597be8125fb6e2aa498b31344", "sha256": "91dd58eaa98caa9f98aa369f22afab08226b43e1433b22ce1ffa35cbcd022e93" }, "downloads": -1, "filename": "pyusuggest-1.0.3.1-py3-none-any.whl", "has_sig": false, "md5_digest": "4cdaf24597be8125fb6e2aa498b31344", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5607, "upload_time": "2018-12-20T13:18:01", "url": "https://files.pythonhosted.org/packages/ad/dc/bd763a42563a5d55c82cde4b03e6619eaa728e8f93430b98f1b8b70118c2/pyusuggest-1.0.3.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "2715e431a4da096f160ef40bf01802e9", "sha256": "2a8a30b80627f39534b233db489826721fa0e18d58e640c8745bcbc00f17b9bc" }, "downloads": -1, "filename": "pyusuggest-1.0.3.1.tar.gz", "has_sig": false, "md5_digest": "2715e431a4da096f160ef40bf01802e9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4666, "upload_time": "2018-12-20T13:18:03", "url": "https://files.pythonhosted.org/packages/96/88/67f538c6c2bc2783c7ed39e08870e7b24a2b2110b956d38ae97e475c96fd/pyusuggest-1.0.3.1.tar.gz" } ], "1.0.4": [ { "comment_text": "", "digests": { "md5": "06760509af4caf70ab16d4effcd89aca", "sha256": "11df1951bbf52ff0880047f2ea5c45f1d8f9b11861e2d9273b41345d3580989e" }, "downloads": -1, "filename": "pyusuggest-1.0.4-py3-none-any.whl", "has_sig": false, "md5_digest": "06760509af4caf70ab16d4effcd89aca", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5581, "upload_time": "2018-12-20T14:07:17", "url": "https://files.pythonhosted.org/packages/5b/11/60165a17e5f0594ec248e26c4cee17ea3c281071322ffd21fc0d4837ad00/pyusuggest-1.0.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4aefe2a842058de6fca323918275f7a4", "sha256": "c547b2a94728983ea9e6294b6f9febd699f8005c87e149b87255f80f8cfdffe2" }, "downloads": -1, "filename": "pyusuggest-1.0.4.tar.gz", "has_sig": false, "md5_digest": "4aefe2a842058de6fca323918275f7a4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4660, "upload_time": "2018-12-20T14:07:18", "url": "https://files.pythonhosted.org/packages/e9/0a/8e0c97084c958b2e576fb66dc28f572988a2b4563ae8196aa95b58592525/pyusuggest-1.0.4.tar.gz" } ], "1.0.5": [ { "comment_text": "", "digests": { "md5": "620a721eb3384e950a25b208595931bd", "sha256": "0471c6e0f110e0a8c6f1a53b4f4bb23d0afb71693716fee531e0a57063d6fd1c" }, "downloads": -1, "filename": "pyusuggest-1.0.5-py3-none-any.whl", "has_sig": false, "md5_digest": "620a721eb3384e950a25b208595931bd", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5896, "upload_time": "2019-02-21T16:43:07", "url": "https://files.pythonhosted.org/packages/01/e9/832a2e259caba0113f659f049103359f45cd160ce6c10d4ea1add7e5b0f1/pyusuggest-1.0.5-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4dd904c579d04d336f3f2b56445d7699", "sha256": "69dbcf0e4cb95e9430ee7b0c10736aedf8411b1f0b370ed8cac18e4bb755c160" }, "downloads": -1, "filename": "pyusuggest-1.0.5.tar.gz", "has_sig": false, "md5_digest": "4dd904c579d04d336f3f2b56445d7699", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4946, "upload_time": "2019-02-21T16:43:09", "url": "https://files.pythonhosted.org/packages/a2/6f/d61acc88585ef7f73c0d4c2b4da210500bed61a7c998b89592ae89e06ca4/pyusuggest-1.0.5.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "620a721eb3384e950a25b208595931bd", "sha256": "0471c6e0f110e0a8c6f1a53b4f4bb23d0afb71693716fee531e0a57063d6fd1c" }, "downloads": -1, "filename": "pyusuggest-1.0.5-py3-none-any.whl", "has_sig": false, "md5_digest": "620a721eb3384e950a25b208595931bd", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5896, "upload_time": "2019-02-21T16:43:07", "url": "https://files.pythonhosted.org/packages/01/e9/832a2e259caba0113f659f049103359f45cd160ce6c10d4ea1add7e5b0f1/pyusuggest-1.0.5-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4dd904c579d04d336f3f2b56445d7699", "sha256": "69dbcf0e4cb95e9430ee7b0c10736aedf8411b1f0b370ed8cac18e4bb755c160" }, "downloads": -1, "filename": "pyusuggest-1.0.5.tar.gz", "has_sig": false, "md5_digest": "4dd904c579d04d336f3f2b56445d7699", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4946, "upload_time": "2019-02-21T16:43:09", "url": "https://files.pythonhosted.org/packages/a2/6f/d61acc88585ef7f73c0d4c2b4da210500bed61a7c998b89592ae89e06ca4/pyusuggest-1.0.5.tar.gz" } ] }