https://github.com/amosbastian/understat
An asynchronous Python package for https://understat.com/.
https://github.com/amosbastian/understat
expected-value football fpl hacktoberfest machine-learning metrics soccer understat
Last synced: 5 months ago
JSON representation
An asynchronous Python package for https://understat.com/.
- Host: GitHub
- URL: https://github.com/amosbastian/understat
- Owner: amosbastian
- License: mit
- Created: 2019-03-06T15:49:04.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-12-16T15:52:42.000Z (6 months ago)
- Last Synced: 2025-12-20T06:55:14.090Z (6 months ago)
- Topics: expected-value, football, fpl, hacktoberfest, machine-learning, metrics, soccer, understat
- Language: Python
- Homepage:
- Size: 99.6 KB
- Stars: 172
- Watchers: 14
- Forks: 33
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing/authors.rst
- License: LICENSE
- Authors: AUTHORS.rst
Awesome Lists containing this project
README
A Python package for https://understat.com/.
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/.