Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mortonfox/munztools
Misc tools for Munzee
https://github.com/mortonfox/munztools
munzee munzee-types oauth2 ruby
Last synced: 3 days ago
JSON representation
Misc tools for Munzee
- Host: GitHub
- URL: https://github.com/mortonfox/munztools
- Owner: mortonfox
- License: mit
- Created: 2018-11-23T21:36:46.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2023-03-16T05:49:49.000Z (over 1 year ago)
- Last Synced: 2024-10-23T04:36:07.583Z (15 days ago)
- Topics: munzee, munzee-types, oauth2, ruby
- Language: Ruby
- Size: 60.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# munztools
Misc tools for Munzee
* diff\_myth: Show how many types of mythologicals you have captured on each
day in a date range.
* munzee\_types: Parse the global Munzee types web page and report on Munzee
counts by type and category.
* capture\_types: Report on player's captures by type and category.
* deploy\_types: Report on player's deploys by type and category.
* munz\_info: Retrieve detailed information on a specific Munzee.
* munz\_addr: Reverse-geocode the coordinates of a Munzee to get its street
address.
## Setup
### General Setup
Run ``bundle install`` to set up the required gems.
You'll also need to obtain a client ID and client secret.
1. Go to the Munzee [Developer Dashboard](https://www.munzee.com/api/apps).
1. Click on 'Create App'.
1. Enter the app details as follows:
* App Name: `munztools`
* Description: `Misc tools for Munzee`
* Redirect URI: `http://localhost:8557/oauth2/callback`
1. Click on 'Create App'.
1. Take note of the ID and Secret of the newly created app.
1. Create a text file named `.munztools.conf` in your home directory.
1. Add the following lines to this file:
```yaml
client_id: CLIENT_ID
client_secret: CLIENT_SECRET
```
where CLIENT\_ID and CLIENT\_SECRET are the ID and Secret you noted above.
### Additional setup for munz\_addr
munz\_addr requires a Bing Maps key. Follow the instructions in [Getting a
Bing Maps
Key](https://docs.microsoft.com/en-us/bingmaps/getting-started/bing-maps-dev-center-help/getting-a-bing-maps-key).
Then add the following line to `.munztools.conf`:
```yaml
bing_maps_key: BING_MAPS_KEY
```
where BING\_MAPS\_KEY is the key you obtained from the Bing Maps Dev Center.
## Usage
For diff\_myth usage info:
```sh
bundle exec ruby diff_myth.rb --help
```
For munzee\_types usage info:
```sh
bundle exec ruby munzee_types.rb --help
```
For capture\_types usage info:
```sh
bundle exec ruby player_stats/capture_types.rb --help
```
For deploy\_types usage info:
```sh
bundle exec ruby player_stats/deploy_types.rb --help
```
For munz\_info usage info:
```sh
bundle exec ruby munz_info --help
```
For munz\_addr usage info:
```sh
bundle exec ruby munz_addr --help
```