{ "info": { "author": "Jakub \"Gradam\" Semik", "author_email": "kuba.semik@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", "Topic :: Internet" ], "description": "It is python wrapper for League of Legends api that watch out to not\nexceed rate limit.\n\nTested on **python 3.5**\n\nFull api documentation:\n`link `__\n\n\nInstallation:\n=============\nPackage is available on PyPI so just use:\n\n``pip install lol_api``\n\nor to install from source:\n\n``git clone https://github.com/gradam/lol_api.git``\n\n``python setup.py test``\n\n``python setup.py install``\n\nUsage:\n======\n\nFirst you need to set up few thing. To do so import settings.\n\n.. code:: python\n\n from lol_api.settings import settings\n settings.API_KEY = 'your_api_key'\n # If you do not wont to pass region to each api call just do:\n settings.REGION_DEFAULT = 'some_region'\n # Now if you are going to use watcher daemon you have to pass server info:\n settings.DAEMON_SERVER = ('server_ip', port)\n # If you prefer to use local watcher instance\n settings.initialize_watcher()\n\nExample:\n--------\n\n.. code:: python\n\n from lol_api.settings import settings\n from lol_api.api.champion import champion\n\n settings.API_KEY = 'mysecretapikey123'\n settings.REGION_DEFAULT = 'eune'\n settings.initialie_watcher(production=True)\n\n data = champion(champion_id=2)\n\n\nDaemon:\n=======\n\nTo use Daemon for watching request count run him in another python instance.\n\n.. code:: python\n\n from lol_api.daemon import ApiDaemon\n daemon = ApiDaemon()\n daemon.run()\n\n\nAdditional arguments:\n\n- ``port`` - Port to run on. Default(8877)\n- ``host`` - Host for socketserver.ThreadingTCPServer. Default('localhost')\n- ``production`` - set requests limit for production limits. Default(False)\n- ``unlimited`` - do not count requests. Default(False)\n- ``log`` - printout information about inquiry. Default(True)\n\n\n\n\nExtra arguments:\n================\n\nTo specify the region pass ``region='your_region'`` as the argument to\nmethod, if not specified ``region_default`` passed to Client will be\nused.\n\nIf lol api accept optional arguments, it should be pass as a keyword\nnamed exactly as expected by api. eg.\n\n.. code:: python\n\n lol_api.api.lol_static_data.champion(champData='all')\n\nAdditional Data:\n================\n\n``lol_api.data``\n----------------\n\n- ``error_codes`` - Explain error codes that you can get from requests\n- ``regions`` - map region names to shortcuts\n- ``platforms`` - map region shortcuts to platform name\n- ``queue_types`` - map queue names to short descriptions\n- ``api_versions`` - map APIs to versions\n\nRate limit:\n===========\n\nWrapper automatically watch to not exceed requests rate limit per region.\nDefault value is 10 per 10 seconds and 500 per 10 minutes. This is\ndefault `limit `__ for\nnon production keys. Id order to use production limit ( 3000 per 10\nseconds and 180000 per 10 minutes ) set PRODUCTION to True in settings.\n\n.. code:: python\n\n lol_api.settings.settings.PRODUCTION = True\n\nYou can also turn this off by setting ``UNLIMITED=True``.\n\n**If Rate limit is exceeded\n``lol_api.exceptions.RateLimitExceededError`` will be raised.**\n\nRunning tests\n=============\n\nRequirements for tests are in tests\\_requirements.txt file.\n\nTo run tests:\n\n``pip install -r tests_requirements.txt``\n\n``py.test``\n\nor run:\n\n``python setup.py test``\n\nTODO:\n=====\n\n- Better documentation\n- Add possibility to cache responses\n- Add inplace translation champion name to id\n- Queue for requests when limit exceeded", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/gradam/lol_api", "keywords": "league of legends api wrapper", "license": "MIT", "maintainer": null, "maintainer_email": null, "name": "lol-api", "package_url": "https://pypi.org/project/lol-api/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/lol-api/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/gradam/lol_api" }, "release_url": "https://pypi.org/project/lol-api/0.2.2/", "requires_dist": null, "requires_python": null, "summary": "wrapper and utils for League of Legends API", "version": "0.2.2" }, "last_serial": 2148892, "releases": { "0.1": [], "0.1.1": [ { "comment_text": "", "digests": { "md5": "f5c89b36aefc12b4b5dccfd2fd76fdf0", "sha256": "58913b7cb496dff2747009752fd3ec4f595a0694316378f1a1f41a754bba76cc" }, "downloads": -1, "filename": "lol_api-0.1.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "f5c89b36aefc12b4b5dccfd2fd76fdf0", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 16703, "upload_time": "2016-05-08T12:51:21", "url": "https://files.pythonhosted.org/packages/f3/65/ba16341c1afb753fdecfb63324071f19db676d53d0adfd58491288329daf/lol_api-0.1.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4a8de869ab3c8f66486768a7ff9bf109", "sha256": "59d2c2ee1380a6f855cffdf3e224e23cac34249d50621b0a00bc74927b614b88" }, "downloads": -1, "filename": "lol_api-0.1.1.tar.gz", "has_sig": false, "md5_digest": "4a8de869ab3c8f66486768a7ff9bf109", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8256, "upload_time": "2016-05-08T12:51:28", "url": "https://files.pythonhosted.org/packages/0c/dd/ab771c877b07fdbfe64f4de3d6e5f06c1f5d638ca9a786ae012716f689ec/lol_api-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "4fe9dda388c8eaa157b4d91d46f8085a", "sha256": "0430e3399e04b9ff53496e6a7ae8a90d5f44b9a2a3d9793a3db7e266026e8859" }, "downloads": -1, "filename": "lol_api-0.1.2.tar.gz", "has_sig": false, "md5_digest": "4fe9dda388c8eaa157b4d91d46f8085a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7066, "upload_time": "2016-05-25T09:01:32", "url": "https://files.pythonhosted.org/packages/f5/33/fcd0b489474afef116366c26ba9428f5b83a033ef946c2860fc360be39c0/lol_api-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "b5b482619bf1f42c461edb61e896907f", "sha256": "c66fda2ef35c58073a9e21a17f44126192f78270fba3ee1355949ac74c0bf798" }, "downloads": -1, "filename": "lol_api-0.1.3.tar.gz", "has_sig": false, "md5_digest": "b5b482619bf1f42c461edb61e896907f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7047, "upload_time": "2016-05-25T09:44:28", "url": "https://files.pythonhosted.org/packages/17/86/4b206d5dbbda157299c01706e69eb8b38987efc9184da0b66ef3101aa6f5/lol_api-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "499ad9042ced169d2a58f556375bef7d", "sha256": "50a2304e721910b23049aa420e5dbeb052592acfc61d632c6c640d8ff204de74" }, "downloads": -1, "filename": "lol_api-0.1.4.tar.gz", "has_sig": false, "md5_digest": "499ad9042ced169d2a58f556375bef7d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13841, "upload_time": "2016-05-25T09:53:13", "url": "https://files.pythonhosted.org/packages/08/6e/95f789b6b21db299b3ee8925f43fae67a3aaf5d75fbb25efdbf80ee82e19/lol_api-0.1.4.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "9e74313bc2f7184ae7150b1d07cd243f", "sha256": "2b9923856740ca3c9e93eb247245bb01e06317436a88bfcc05fa735bac8d7da3" }, "downloads": -1, "filename": "lol_api-0.1.5.tar.gz", "has_sig": false, "md5_digest": "9e74313bc2f7184ae7150b1d07cd243f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13866, "upload_time": "2016-05-25T09:58:18", "url": "https://files.pythonhosted.org/packages/be/5e/9a0694fcb597aef6292a3d6ca96f507d30a16e2ef48d75ae99f6baf585c7/lol_api-0.1.5.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "14b8767ae1fb0901e677902e0a79420d", "sha256": "34614b04b8de17a2ab7e80c62a82b5e853c9dc7f29c88fb7a445e0d62e426b96" }, "downloads": -1, "filename": "lol_api-0.2.0.tar.gz", "has_sig": false, "md5_digest": "14b8767ae1fb0901e677902e0a79420d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9294, "upload_time": "2016-05-27T15:22:57", "url": "https://files.pythonhosted.org/packages/f8/24/c54f4ffd9f17423c6f2c09ce14e7fa629142ae552abdd34e064b7d63198a/lol_api-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "5dc5f82358711a4e09a78ddf715b9e19", "sha256": "e268ee9895f4ff15c8077654deb0d003d139b5906ac882de2e44ed11789ae116" }, "downloads": -1, "filename": "lol_api-0.2.1.tar.gz", "has_sig": false, "md5_digest": "5dc5f82358711a4e09a78ddf715b9e19", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8788, "upload_time": "2016-05-28T16:43:01", "url": "https://files.pythonhosted.org/packages/4a/1c/3f9429635fa24a294f15b3761b31fe5111c9da76a8fe524a6de7e78f6607/lol_api-0.2.1.tar.gz" } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "81a93eae3946524a4d1716bf363e93e3", "sha256": "5d9ecbb3a3be7dcc391119a672a2aadb3fb5eb8fc71017d16c3a072027cc6011" }, "downloads": -1, "filename": "lol_api-0.2.2.tar.gz", "has_sig": false, "md5_digest": "81a93eae3946524a4d1716bf363e93e3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9281, "upload_time": "2016-06-03T11:42:54", "url": "https://files.pythonhosted.org/packages/7f/20/591d383d848445ffc9d9cec3e776b1f297069d166458c4aec6bafcf09af5/lol_api-0.2.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "81a93eae3946524a4d1716bf363e93e3", "sha256": "5d9ecbb3a3be7dcc391119a672a2aadb3fb5eb8fc71017d16c3a072027cc6011" }, "downloads": -1, "filename": "lol_api-0.2.2.tar.gz", "has_sig": false, "md5_digest": "81a93eae3946524a4d1716bf363e93e3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9281, "upload_time": "2016-06-03T11:42:54", "url": "https://files.pythonhosted.org/packages/7f/20/591d383d848445ffc9d9cec3e776b1f297069d166458c4aec6bafcf09af5/lol_api-0.2.2.tar.gz" } ] }