merge develop in master

.gitignore

@@ -87,12 +87,6 @@ Temporary Items
 *.la
 *.lo
 
-# Shared objects (inc. Windows DLLs)
-*.dll
-*.so
-*.so.*
-*.dylib
-
 # Executables
 *.exe
 *.out
@@ -122,8 +116,6 @@ __pycache__/
 *.py[cod]
 *$py.class
 
-# C extensions
-
 # Distribution / packaging
 .Python
 env/
@@ -223,8 +215,6 @@ ENV/
 # Compiled Static libraries
 *.lai
 
-# Executables
-
 
 ### SublimeText ###
 # cache files for sublime text
@@ -272,3 +262,4 @@ pip-selfcheck.json
 
 ### Node ###
 node_modules
+test.py

.travis.yml

@@ -3,27 +3,11 @@ language: python
 python:
   - "2.7"
   - "3.5"
+  - "3.6"
 
 install:
-  - sudo apt-get update
-
-  - if [[ "$TRAVIS_PYTHON_VERSION" == "2.7" ]]; then
-      wget https://repo.continuum.io/miniconda/Miniconda2-latest-Linux-x86_64.sh -O miniconda.sh;
-    else
-      wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh;
-    fi
-  - bash miniconda.sh -b -p $HOME/miniconda
-  - export PATH="$HOME/miniconda/bin:$PATH"
-  - hash -r
-  - conda config --set always_yes yes --set changeps1 no
-  - conda update -q conda
-  - conda info -a
-
-  - conda create -q -n test-environment python=$TRAVIS_PYTHON_VERSION
-  - source activate test-environment
-
   - pip install -r requirements.txt
   - python setup.py install
 
 script:
-  - true
+  - python -c 'import pgoapi'

MANIFEST.in

@@ -1,6 +1,4 @@
 recursive-include pgoapi *.py
 
-global-exclude *.dll
 global-exclude *.pyc
 global-exclude *.pyo
-global-exclude *.so

README.md

@@ -28,12 +28,31 @@ Documentation is available at the github [pgoapi wiki](https://wiki.pogodev.org)
  * requests
  * protobuf (>=3)
  * gpsoauth
+ * s2sphere
  * geopy (only for pokecli demo)
- * s2sphere (only for pokecli demo)
 
-## Contribution
+## Use
+To use this api as part of a python project using setuptools/pip, modify your requirements.txt file to include:
+```
+git+https://github.com/pogodevorg/pgoapi.git@develop#egg=pgoapi
+```
+
+If you are not using setuptools/pip, follow the instructions in the Contributing section below to clone this repository and then install pgoapi using the appropriate method for your project.
+
+## Contributing
 Contributions are highly welcome. Please use github or [Discord](https://discord.pogodev.org) for it!
 
+You can get started by cloning this repository. Note that as pgoapi uses [git submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) you must perform a recursive clone:
+
+| Protocol | Command |
+| -------- | ------- |
+| HTTPS | `git clone --recursive https://github.com/pogodevorg/pgoapi.git` |
+| SSH   | `git clone --recursive git@github.com:pogodevorg/pgoapi.git` |
+
+If you already have a copy of the repository you can use `git submodule update --init` to fetch and update the submodules.
+
+Once you have cloned the repository, switch to the `develop` branch. To merge your changes back into the main repository, make a pull request to `develop`.
+
 ## Credits
 [Mila432](https://github.com/Mila432/Pokemon_Go_API) for the login secrets  
 [elliottcarlson](https://github.com/elliottcarlson) for the Google Auth PR