Metadata-Version: 2.1
Name: fplcli
Version: 0.1.8
Summary: A CLI tool for Fantasy Premier League
Home-page: https://github.com/janerikcarlsen/fpl-cli
Author: Jan-Erik Carlsen
Author-email: jan.erik.carlsen@gmail.com
License: UNKNOWN
Project-URL: Docs, https://pypi.org/project/fplcli/
Project-URL: Source, https://github.com/janerikcarlsen/fpl-cli
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Developers
Classifier: Topic :: Games/Entertainment
Description-Content-Type: text/markdown
Requires-Dist: requests
Requires-Dist: future
Requires-Dist: click
Requires-Dist: pyfiglet
Requires-Dist: six
Requires-Dist: Prettytable
Requires-Dist: termcolor
Requires-Dist: colorama
Requires-Dist: configparser

[![Build Status](https://travis-ci.org/janerikcarlsen/fpl-cli.svg?branch=master)](https://travis-ci.org/janerikcarlsen/fpl-cli)
[![Python Versions](https://img.shields.io/pypi/pyversions/fplcli.svg)](https://pypi.org/project/fplcli)
[![Downloads](http://pepy.tech/badge/fplcli)](http://pepy.tech/project/fplcli)

# fpl-cli
fpl-cli is a command line tool for Fantasy Premier League, written in Python.
The tool gets its data from the official Fantasy Premier League API, and currently supports the following actions:  
```
fpl                     Returns help menu
fpl configure           Set up team_id (required)
fpl points              Returns live points for a team
fpl leagues             Returns all leagues for a team entry
fpl league <id>         Returns confirmed scores for a league by id
fpl liveleague <id>     Returns live scores for a league by id
fpl entry               Returns information about a team entry
fpl players             Returns all players in the game, sorted by total score
```

# Installing 
fpl-cli has been tested with Python versions 2.7, 3.4, 3.5, 3.6 and 3.7 on Mac and Linux, and with 3.6 and 3.7 on Windows.

In a terminal window, verify that Python and pip is available:
```
python --version
pip --version
``` 
If no Python/pip version is found, [download Python and pip before proceeding](https://www.python.org/downloads/)
```
pip install fplcli
```

# Using fpl-cli
## Configure fpl-cli 
Start using fpl-cli by telling it your team_id. You can find your team_id by going to the Points tab at https://fantasy.premierleague.com and find the number in between `team/` and `event/` in the url.

![fpl configure](https://raw.githubusercontent.com/janerikcarlsen/fpl-cli/master/docs/img/fpl_configure.png "fpl configure")

## Get help 
Get an overview of the allowed actions by typing `fpl` or `fpl --help`

![fpl help](https://raw.githubusercontent.com/janerikcarlsen/fpl-cli/master/docs/img/fpl_help.png  "fpl help")

## Get current points total for team
The points total and player score is updated during games based on live score data. Provisional bonus are not included yet.

![fpl points](https://raw.githubusercontent.com/janerikcarlsen/fpl-cli/master/docs/img/fpl_points.png "fpl points")

## Get all leagues the team is member of
Returns all leagues you participate in (Head 2 Head leagues not included yet)

![fpl leagues](https://raw.githubusercontent.com/janerikcarlsen/fpl-cli/master/docs/img/fpl_leagues.png "fpl leagues")

## Get league standings
Returns league standings for a single league. You find the league_id in the leftmost `Id` column in the `fpl leagues` result

![fpl league](https://raw.githubusercontent.com/janerikcarlsen/fpl-cli/master/docs/img/fpl_league.png "fpl league")

## Get live league standings
Returns live league standings for a single league, where all teams score are updated in real time based on live score data. This one is a separate action from the `fpl league` action because it requires ~2 API calls for each team in the league and is therefore slower (~1-10 seconds depending on league size and response times from Fantasy Premier League API).

![fpl liveleague](https://raw.githubusercontent.com/janerikcarlsen/fpl-cli/master/docs/img/fpl_liveleague.png "fpl liveleague")


# Planned features
Planned future features include:

* Include all major features from fantasy.premierleague.com
* Include H2H leagues in leagues view
* Actions that require authentication with the FPL API (Making transfers, prepare team for next Gameweek)
* Live updates of league standings during games based on new points total
* Include provisional bonus in live league and points view
* Player sorting/filtering and enriched player staticstics
* Cache API calls to improve response times, especially for live leagues
* Transfer suggestions based on form and upcoming fixture difficulty

Ideas for features or enhancements that you would like to see from fpl-cli are welcome. 
Please post an [issue in the GitHub repository](https://github.com/janerikcarlsen/fpl-cli/issues), 
or even better, check out the [Contributing guidelines](https://github.com/janerikcarlsen/fpl-cli/blob/master/CONTRIBUTING.md "CONTRIBUTING.md") 
and submit a Pull Request with the suggested change.


