<center>
![](https://i.imgur.com/ao1t2qN.png)
<br>
<sup>
https://github.com/amosbastian/fpl
</sup>
</center>

### What is **fpl**?

It's a Python wrapper for the [Fantasy Premier League](https://fantasy.premierleague.com/), which is a fantasy football game - "a game in which participants assemble an imaginary team of real life footballers and score points based on those players' actual statistical performance or their perceived contribution on the field of play. " At the time of writing this post there are more than 6 million teams entered, which includes loads of people on Steem who are participating in Steem's very own league (see [here](https://steemit.com/premierleague/@acidyo/4egmxy-steem-fantasy-premier-league-gameweek-1-preview)).

---

### Update

The 2019/2020 season of the Premier League started a while ago. With this they decided to change a lot of the endpoints of their API, and also what the endpoints actually return for some reason. Because of this I had to change quite a lot to get everything back in working fashion, but I think everything should be working properly with version 0.6.8 (as long as they don't keep changing things)! 

On a side note: the package has hit 50 stars, which makes me very proud, and the [Discord server](https://discord.gg/cjY37fv) has reached ~80 users! Don't hesitate to give the project a star yourself and join the discussion on Discord!

### Usage & installation

The recommended way to install fpl is via ``pip``.

    pip install fpl

To install it directly from GitHub you can do the following:

    git clone git://github.com/amosbastian/fpl.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/fpl/tarball/master
    $ curl -OL https://github.com/amosbastian/fpl/zipball/master # Windows

Once it has been downloaded you can easily install it using `pip`::

    $ cd fpl
    $ pip install .

## 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, contact me on Discord 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.

For more information on how to contribute to **fpl** see [the contributing guide](https://fpl.readthedocs.io/en/latest/contributing/contributing.html).

## Documentation

Documentation and examples for **fpl** can be found at http://fpl.readthedocs.io/en/latest/.