README.md

Pokemon Go - Trainer Tools

The Pokemon GO tool to extract and display player informations (without cheats and scripted actions !)

Table of Contents

• About branches
• Features
• Getting started
  • Basic installation
  • Usage
  • Remote API with server installation
• FAQ
• TODO list
• Contributing guidelines
• Contributors
• Credits

About branches

Dev

Dev branch has the most up-to-date features, but be aware that there might be some broken changes. Your contribution and PR for fixes are warm welcome.

Master

Master branch is the stable branch. No PR on master branch to keep things easier.

Features

• TODO

Getting started

Basic installation

Basic Installation (see INSTALL.md)

Note on virtualenv

We recommend you use virtualenv, not only will this tool keep your OS clean from all the python plugins. It also provide an virtual space for more than 1 instance!

Usage

Start a scan

python trainertools.py

Launch a web server

• Use apache or nginx

TODO

• Use SimpleHTTPServer with python

From web directory :

python -m SimpleHTTPServer

You can now visit the web page at http://127.0.0.1:8000

Remote API with server installation

Remote server installation (see remote_INSTALL.md) (TODO)

Start server

python trainertools.py -os

FAQ

Wiki - FAQ (TODO)

TODO list

• Complete README.md section
• Complete wiki section (Home, Getting started, FAQ, Dev guidelines)

Contributing guidelines

See CONTRIBUTING (TODO)

---

Contributors

Don't forget add yours here when you create PR

---

Credits

• tejado for the API
• OpenPoGo for the front web tools
• PokemonGoF for the docs and wiki