murphyjohn / fpl

A Python wrapper for the Fantasy Premier League API.

A Python wrapper around the Fantasy Premier League API

Join the Discord server or submit an issue for help and / or suggestions!

Installing fpl

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 or .zip file

$ 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 [email protected].
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.

Documentation

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