From a09d5dba095314f4cb76f5480f6328a19b2668e8 Mon Sep 17 00:00:00 2001 From: schneefux Date: Wed, 18 Jan 2017 18:38:08 +0100 Subject: README -> README.md --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..6f16b34 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +python-gamelocker +=== + +[Private mirror](https://git.schneefux.xyz/schneefux/python-gamelocker) [GitHub mirror](https://github.com/schneefux/python-gamelocker) + +Python 3 wrapper for the Gamelocker API. Currently supports [Vainglory](https://developers.vainglorygame.com). Install with PyPi: `pip install python-gamelocker`. + +[Private docs mirror](https://docs.schneefux.xyz/python-gamelocker) [GitHub docs mirror](https://schneefux.github.io/python-gamelocker) + +Example usage: +```python +>>> import gamelocker +>>> APIKEY = "aaa.bbb.ccc" +>>> api = gamelocker.Gamelocker(APIKEY).Vainglory() +>>> m = api.matches(limit=2, player="TheLegend27") +>>> m +[, ] +>>> m.rosters[0].participants[0].player.name +"iiDruid" +>>> m.rosters[0].participants[0].stats.kills +10 +>>> m.rosters[0].stats.acesEarned +2 +``` -- cgit v1.3.1