https://github.com/amosbastian/fpl

An asynchronous Python wrapper for the Fantasy Premier League API.
https://github.com/amosbastian/fpl

cli fantasy-football fantasy-premier-league football fpl hacktoberfest

Last synced: 4 months ago
JSON representation

An asynchronous Python wrapper for the Fantasy Premier League API.

• Host: GitHub
• URL: https://github.com/amosbastian/fpl
• Owner: amosbastian
• License: mit
• Created: 2018-01-10T15:12:49.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-07-26T11:00:57.000Z (almost 2 years ago)
• Last Synced: 2025-12-20T04:22:26.792Z (4 months ago)
• Topics: cli, fantasy-football, fantasy-premier-league, football, fpl, hacktoberfest
• Language: Python
• Homepage: https://fpl.readthedocs.io
• Size: 468 KB
• Stars: 320
• Watchers: 17
• Forks: 105
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing/authors.rst
  • License: LICENSE.txt
  • Authors: AUTHORS.rst

Awesome Lists containing this project

README

          


  

    

  





    A Python wrapper around the Fantasy Premier League API

    


    


    

        

    

        

    

        

    

        

    

        



Join the [Discord server](https://discord.gg/cjY37fv) or submit [an issue](https://github.com/amosbastian/fpl/issues) 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](https://github.com/amosbastian/fpl/tarball/master)

or [.zip file](https://github.com/amosbastian/fpl/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. Create a `credentials.cfg` file with your FPL login and password (see [example](docs/_static/example-credentials-file.cfg)).

3. 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/.