<p align="center">
A Python package for https://understat.com/.
<br>
<br>
<a href="https://travis-ci.com/amosbastian/understat"><img src="https://travis-ci.com/amosbastian/understat.svg?branch=master"></a>
<a href="https://pypi.org/project/understat/" alt="Version">
<img src="https://badge.fury.io/py/understat.svg"/></a>
<a href="https://pypi.org/project/understat/" alt="Python version">
<img src="https://img.shields.io/badge/Python-3.6%2B-blue.svg"/></a>
<a href="https://understat.readthedocs.io/en/latest/" alt="Documentation">
<img src="https://readthedocs.org/projects/understat/badge/?version=latest&style=flat"></a>
</p>
Join the [Discord server](https://discord.gg/cjY37fv) or submit [an issue](https://github.com/amosbastian/understat/issues) for help and / or suggestions!
## Installing understat
The recommended way to install understat is via `pip`.
pip install understat
To install it directly from GitHub you can do the following:
git clone git://github.com/amosbastian/understat.git
You can also install a [.tar file](https://github.com/requests/requests/tarball/master)
or [.zip file](https://github.com/requests/requests/tarball/master)
curl -OL https://github.com/amosbastian/understat/tarball/master
curl -OL https://github.com/amosbastian/understat/zipball/master # Windows
Once it has been downloaded you can easily install it using `pip`:
cd understat
pip install .
## Usage
An example of using `understat` can be found below:
```python
import asyncio
import json
import aiohttp
from understat import Understat
async def main():
async with aiohttp.ClientSession() as session:
understat = Understat(session)
data = await understat.get_league_players("epl", 2018, {"team_title": "Manchester United"})
print(json.dumps(data))
if __name__ == "__main__":
loop = asyncio.new_event_loop()
asyncio.set_event_loop(loop)
loop.run_until_complete(main())
```
## Contributing
1. Fork the repository on GitHub.
2. Run the tests with `pytest tests/` to confirm they all pass on your system.
If the tests fail, then try and find out why this is happening. If you aren't
able to do this yourself, then don't hesitate to either create an issue on
GitHub, or send an email to [amosbastian@gmail.com](mailto:amosbastian@gmail.com>).
3. Either create your feature and then write tests for it, or do this the other
way around.
4. Run all tests again with with `pytest tests/` to confirm that everything
still passes, including your newly added test(s).
5. Create a pull request for the main repository's `master` branch.
## Documentation
Documentation and examples for **understat** can be found at http://understat.readthedocs.io/en/latest/.
Raw data
{
"_id": null,
"home_page": "https://github.com/amosbastian/understat",
"name": "understat",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "fpl fantasy premier league understat football",
"author": "amosbastian",
"author_email": "amosbastian@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/1a/50/3c28c1c3b088de6933b35d580caf145109321cfef4a643ad043b366b99cb/understat-0.1.12.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n A Python package for https://understat.com/.\n <br>\n <br>\n <a href=\"https://travis-ci.com/amosbastian/understat\"><img src=\"https://travis-ci.com/amosbastian/understat.svg?branch=master\"></a>\n <a href=\"https://pypi.org/project/understat/\" alt=\"Version\">\n <img src=\"https://badge.fury.io/py/understat.svg\"/></a>\n <a href=\"https://pypi.org/project/understat/\" alt=\"Python version\">\n <img src=\"https://img.shields.io/badge/Python-3.6%2B-blue.svg\"/></a>\n <a href=\"https://understat.readthedocs.io/en/latest/\" alt=\"Documentation\">\n <img src=\"https://readthedocs.org/projects/understat/badge/?version=latest&style=flat\"></a>\n</p>\n\nJoin the [Discord server](https://discord.gg/cjY37fv) or submit [an issue](https://github.com/amosbastian/understat/issues) for help and / or suggestions!\n\n## Installing understat\n\nThe recommended way to install understat is via `pip`.\n\n pip install understat\n\nTo install it directly from GitHub you can do the following:\n\n git clone git://github.com/amosbastian/understat.git\n\nYou can also install a [.tar file](https://github.com/requests/requests/tarball/master)\nor [.zip file](https://github.com/requests/requests/tarball/master)\n\n curl -OL https://github.com/amosbastian/understat/tarball/master\n curl -OL https://github.com/amosbastian/understat/zipball/master # Windows\n\nOnce it has been downloaded you can easily install it using `pip`:\n\n cd understat\n pip install .\n\n## Usage\n\nAn example of using `understat` can be found below:\n\n```python\nimport asyncio\nimport json\n\nimport aiohttp\n\nfrom understat import Understat\n\n\nasync def main():\n async with aiohttp.ClientSession() as session:\n understat = Understat(session)\n data = await understat.get_league_players(\"epl\", 2018, {\"team_title\": \"Manchester United\"})\n print(json.dumps(data))\n\n\nif __name__ == \"__main__\":\n loop = asyncio.new_event_loop()\n asyncio.set_event_loop(loop)\n loop.run_until_complete(main())\n```\n\n\n## Contributing\n\n1. Fork the repository on GitHub.\n2. Run the tests with `pytest tests/` to confirm they all pass on your system.\n If the tests fail, then try and find out why this is happening. If you aren't\n able to do this yourself, then don't hesitate to either create an issue on\n GitHub, or send an email to [amosbastian@gmail.com](mailto:amosbastian@gmail.com>).\n3. Either create your feature and then write tests for it, or do this the other\n way around.\n4. Run all tests again with with `pytest tests/` to confirm that everything\n still passes, including your newly added test(s).\n5. Create a pull request for the main repository's `master` branch.\n\n## Documentation\n\nDocumentation and examples for **understat** can be found at http://understat.readthedocs.io/en/latest/.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python wrapper for https://understat.com/",
"version": "0.1.12",
"project_urls": {
"Documentation": "http://fpl.readthedocs.io/en/latest/",
"Homepage": "https://github.com/amosbastian/understat",
"Source": "https://github.com/amosbastian/fpl"
},
"split_keywords": [
"fpl",
"fantasy",
"premier",
"league",
"understat",
"football"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2d85cf2fe8788208d0c95e8ceea77bc0b55eb1d788d98e67b54ce92fca75ccc2",
"md5": "8d0c132b5784cdd368dcde0973449fe1",
"sha256": "99e52e5eaec269234b3c026a74d82bd9d0d14f60076e3f1524a60bf54c674ca8"
},
"downloads": -1,
"filename": "understat-0.1.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8d0c132b5784cdd368dcde0973449fe1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 10430,
"upload_time": "2024-01-28T13:48:25",
"upload_time_iso_8601": "2024-01-28T13:48:25.970009Z",
"url": "https://files.pythonhosted.org/packages/2d/85/cf2fe8788208d0c95e8ceea77bc0b55eb1d788d98e67b54ce92fca75ccc2/understat-0.1.12-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1a503c28c1c3b088de6933b35d580caf145109321cfef4a643ad043b366b99cb",
"md5": "fb37561d5b19645f027293633228a4f8",
"sha256": "ac49b608f3c3632b12140f5140b483ed139fed52b6c548c9706d45c81c67e562"
},
"downloads": -1,
"filename": "understat-0.1.12.tar.gz",
"has_sig": false,
"md5_digest": "fb37561d5b19645f027293633228a4f8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10203,
"upload_time": "2024-01-28T13:48:27",
"upload_time_iso_8601": "2024-01-28T13:48:27.721103Z",
"url": "https://files.pythonhosted.org/packages/1a/50/3c28c1c3b088de6933b35d580caf145109321cfef4a643ad043b366b99cb/understat-0.1.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-28 13:48:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "amosbastian",
"github_project": "understat",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "understat"
}
JSON
