Skip to content
This repository has been archived by the owner on Dec 15, 2018. It is now read-only.

WIP: Rewrite README for clarity #215

Open
wants to merge 6 commits into
base: develop
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 32 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
[![Build Status](https://travis-ci.org/tejado/pgoapi.svg?branch=master)](https://travis-ci.org/tejado/pgoapi)
[![POGODEV](https://github.com/pogodevorg/assets/blob/master/public/img/logo-github.png?raw=true)](https://pogodev.org)

# pgoapi - a pokemon go api lib in python
pgoapi is a client/api/demo for Pokemon Go by https://github.com/tejado.
# pgoapi - a pokemon go api lib in python [![Build Status](https://travis-ci.org/pogodevorg/pgoapi.svg?branch=develop)](https://travis-ci.org/pogodevorg/pgoapi)

pgoapi is a client/api/demo for Pokemon Go by https://github.com/tejado & https://github.com/pogodevorg.
It allows automatic parsing of requests/responses by finding the correct protobuf objects over a naming convention and will return the response in a parsed python dictionary format.

* This is unofficial - USE AT YOUR OWN RISK !
* I don't play pokemon go !
* No bot/farming code included !
## Disclaimers

* This is unofficial - **USE AT YOUR OWN RISK**!
* Botting or farming is **not supported**.

## Features

## Feature Support
* Python 2 and 3
* Google/PTC auth
* Address parsing for GPS coordinates
Expand All @@ -18,7 +21,7 @@ It allows automatic parsing of requests/responses by finding the correct protobu
* Thread-safety
* Advanced logging/debugging
* Uses [POGOProtos](https://github.com/AeonLucid/POGOProtos)
* Mostly all available RPC calls (see [API reference](https://docs.pogodev.org) on the wiki)
* Most RPC calls are available (see [API reference](https://docs.pogodev.org) on the wiki)

## Documentation
Documentation is available at the github [pgoapi wiki](https://wiki.pogodev.org).
Expand All @@ -39,6 +42,10 @@ 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.

### Hashing

The API utilises the [API Hashing service](https://hashing.pogodev.org) provided by Bossland. Calls require a valid hash key to work on newer API Versions.

## Contributing
Contributions are highly welcome. Please use github or [Discord](https://discord.pogodev.org) for it!

Expand All @@ -53,16 +60,24 @@ If you already have a copy of the repository you can use `git submodule update -

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`.

## Core Maintainers

[![Noctem](https://github.com/Noctem.png?size=36) - Noctem](https://github.com/Noctem)

[![ZeChrales](https://github.com/ZeChrales.png?size=36) - ZeChrales](https://github.com/ZeChrales)

[![Ephemerality](https://github.com/Ephemerality.png?size=36) - Ephemerality](https://github.com/Ephemerality)


## Credits
[Mila432](https://github.com/Mila432/Pokemon_Go_API) for the login secrets
[elliottcarlson](https://github.com/elliottcarlson) for the Google Auth PR
[AeonLucid](https://github.com/AeonLucid/POGOProtos) for improved protos
[AHAAAAAAA](https://github.com/AHAAAAAAA/PokemonGo-Map) for parts of the s2sphere stuff
[mikeres0](https://github.com/mikeres0) for the slack channel including auto signup
[DeirhX](https://github.com/DeirhX) for thread-safety

* [Mila432](https://github.com/Mila432/Pokemon_Go_API) for the login secrets
* [elliottcarlson](https://github.com/elliottcarlson) for the Google Auth PR
* [AeonLucid](https://github.com/AeonLucid/POGOProtos) for improved protos
* [AHAAAAAAA](https://github.com/AHAAAAAAA/PokemonGo-Map) for parts of the s2sphere stuff
* [mikeres0](https://github.com/mikeres0) for the slack channel including auto signup
* [DeirhX](https://github.com/DeirhX) for thread-safety

## Ports
[Node Port](https://github.com/Armax/Pokemon-GO-node-api) by Arm4x
[Node Port - pogobuf](https://github.com/cyraxx/pogobuf) by cyraxx

[![Analytics](https://ga-beacon.appspot.com/UA-1911411-4/pgoapi.git/README.md?pixel&useReferer)](https://github.com/igrigorik/ga-beacon)
See [Awesome Pokemon Go](https://github.com/pogodevorg/awesome-pokemongo#api-libraries)