From 0130136613200f7122ed133b4524317c0a92f9c5 Mon Sep 17 00:00:00 2001 From: Jamie Bishop Date: Fri, 21 Jul 2017 11:11:00 +0100 Subject: [PATCH 1/6] Somewhat update README --- README.md | 46 ++++++++++++++++++++++++++++++---------------- 1 file changed, 30 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 41e6f250..3285f024 100644 --- a/README.md +++ b/README.md @@ -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/tejado/pgoapi.svg?branch=master)](https://travis-ci.org/tejado/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 @@ -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) + * MostRPC 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). @@ -53,16 +56,27 @@ 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 + +### Node JS +[pogosandbox/pogobuf](https://github.com/pogosandbox/pogobuf) +[Pokemon GO node api](https://github.com/Armax/Pokemon-GO-node-api) by Arm4x **deprecated** +[cyraxx/pogobuf](https://github.com/cyraxx/pogobuf) by cyraxx **deprecated** [![Analytics](https://ga-beacon.appspot.com/UA-1911411-4/pgoapi.git/README.md?pixel&useReferer)](https://github.com/igrigorik/ga-beacon) From 016d5b3811b0f030a52845cc593bcd0fa92974d3 Mon Sep 17 00:00:00 2001 From: Jamie Bishop Date: Fri, 21 Jul 2017 11:16:45 +0100 Subject: [PATCH 2/6] Clarity & formatting --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3285f024..5a7ab4e8 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ [![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 [![Build Status](https://travis-ci.org/tejado/pgoapi.svg?branch=master)](https://travis-ci.org/tejado/pgoapi) +# 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. @@ -21,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) - * MostRPC calls are available (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). @@ -42,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! @@ -59,7 +63,9 @@ Once you have cloned the repository, switch to the `develop` branch. To merge yo ## 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) From 68fe685a42168cb68018fecbcfb1c5f347f6e65c Mon Sep 17 00:00:00 2001 From: Jamie Bishop Date: Fri, 21 Jul 2017 11:18:06 +0100 Subject: [PATCH 3/6] Formatting is hard --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 5a7ab4e8..a320fe51 100644 --- a/README.md +++ b/README.md @@ -82,7 +82,9 @@ Once you have cloned the repository, switch to the `develop` branch. To merge yo ### Node JS [pogosandbox/pogobuf](https://github.com/pogosandbox/pogobuf) + [Pokemon GO node api](https://github.com/Armax/Pokemon-GO-node-api) by Arm4x **deprecated** + [cyraxx/pogobuf](https://github.com/cyraxx/pogobuf) by cyraxx **deprecated** [![Analytics](https://ga-beacon.appspot.com/UA-1911411-4/pgoapi.git/README.md?pixel&useReferer)](https://github.com/igrigorik/ga-beacon) From 4039029391d24b54990ccddafb950c1d8ad49a0e Mon Sep 17 00:00:00 2001 From: Jamie Bishop Date: Fri, 21 Jul 2017 11:18:42 +0100 Subject: [PATCH 4/6] More formatting --- README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a320fe51..73bd7cdf 100644 --- a/README.md +++ b/README.md @@ -81,10 +81,8 @@ Once you have cloned the repository, switch to the `develop` branch. To merge yo ## Ports ### Node JS -[pogosandbox/pogobuf](https://github.com/pogosandbox/pogobuf) - -[Pokemon GO node api](https://github.com/Armax/Pokemon-GO-node-api) by Arm4x **deprecated** - -[cyraxx/pogobuf](https://github.com/cyraxx/pogobuf) by cyraxx **deprecated** +* [pogosandbox/pogobuf](https://github.com/pogosandbox/pogobuf) +* [Pokemon GO node api](https://github.com/Armax/Pokemon-GO-node-api) by Arm4x **deprecated** +* x[cyraxx/pogobuf](https://github.com/cyraxx/pogobuf) by cyraxx **deprecated** [![Analytics](https://ga-beacon.appspot.com/UA-1911411-4/pgoapi.git/README.md?pixel&useReferer)](https://github.com/igrigorik/ga-beacon) From f4c6f3b1f196ac36a9624a4b0be7f80e045292f4 Mon Sep 17 00:00:00 2001 From: Jamie Bishop Date: Fri, 21 Jul 2017 11:19:05 +0100 Subject: [PATCH 5/6] even more formatting --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 73bd7cdf..2b2b50f6 100644 --- a/README.md +++ b/README.md @@ -83,6 +83,6 @@ Once you have cloned the repository, switch to the `develop` branch. To merge yo ### Node JS * [pogosandbox/pogobuf](https://github.com/pogosandbox/pogobuf) * [Pokemon GO node api](https://github.com/Armax/Pokemon-GO-node-api) by Arm4x **deprecated** -* x[cyraxx/pogobuf](https://github.com/cyraxx/pogobuf) by cyraxx **deprecated** +* [cyraxx/pogobuf](https://github.com/cyraxx/pogobuf) by cyraxx **deprecated** [![Analytics](https://ga-beacon.appspot.com/UA-1911411-4/pgoapi.git/README.md?pixel&useReferer)](https://github.com/igrigorik/ga-beacon) From 8ce20b534f3ea832decc09d6994c9f8f80deb9f4 Mon Sep 17 00:00:00 2001 From: Jamie Bishop Date: Sat, 22 Jul 2017 08:52:35 +0100 Subject: [PATCH 6/6] Make ports a link to awesome pogo --- README.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/README.md b/README.md index 2b2b50f6..e341cc51 100644 --- a/README.md +++ b/README.md @@ -80,9 +80,4 @@ Once you have cloned the repository, switch to the `develop` branch. To merge yo ## Ports -### Node JS -* [pogosandbox/pogobuf](https://github.com/pogosandbox/pogobuf) -* [Pokemon GO node api](https://github.com/Armax/Pokemon-GO-node-api) by Arm4x **deprecated** -* [cyraxx/pogobuf](https://github.com/cyraxx/pogobuf) by cyraxx **deprecated** - -[![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)