Enhancements to geohash-btc

geohash.py

@@ -1,62 +1,171 @@
-#!/usr/bin/python
-
-# Copyright 2011 Mark Holmquist
-# This script is free software, licensed under the GPLv3, of which you should have received a copy with this software.
-# If you didn't, I apologize, but you'll be able to find it at /usr/share/common-licences/GPL-3 or http://www.gnu.org/licenses/gpl-3.0.txt
-
-# This script will calculate a geohash location for you based on the opening price at Mt. Gox for BTC/USD trades.
-# Usually, people use the DJIA for this algorithm, but I didn't think that was nerdy enough :)
-# It will also automagically give you a link to a google map to the location.
-# If you'd like any help with it, don't hesitate to open up an issue at github.
-# Have fun!
-
-import datetime
-import hashlib
-import json
-import urllib
-
-latitude = 33
-longitude = -116
-
-btcinfo = urllib.urlopen("http://bitcoincharts.com/t/markets.json")
-jsoninfo = btcinfo.read()
-
-dictinfo = json.loads(jsoninfo)
-
-todayopen = -1
-for sym in dictinfo:
-    if sym["symbol"] == "mtgoxUSD":
-        todayopen = sym["open"]
-    else:
-        continue
-
-if todayopen < 0:
-    raise ValueError("No data from bitcoincharts, is it down?")
-
-thestring = str(datetime.date.today()) + "-" + str(todayopen)
-
-thehash = hashlib.md5(thestring).hexdigest()
-
-hexnum = (thehash[0:16], thehash[16:32])
-
-curpow = 1
-decnum = [0.0, 0.0]
-
-while curpow <= len(hexnum[0]):
-    decnum[0] += int(hexnum[0][curpow-1], 16) * (1.0 / (16.0 ** curpow))
-    decnum[1] += int(hexnum[1][curpow-1], 16) * (1.0 / (16.0 ** curpow))
-    curpow += 1
-
-if latitude >= 0:
-    decnum[0] += latitude
-else:
-    decnum[0] -= latitude
-    decnum[0] *= -1
-
-if longitude >= 0:
-    decnum[1] += longitude
-else:
-    decnum[1] -= longitude
-    decnum[1] *= -1
-
-print "http://maps.google.com/maps?q=" + str(decnum[0]) + "," + str(decnum[1]) + "(Geohash+for+" + str(datetime.date.today()) + ")&iwloc=A"
+#!/usr/bin/python
+
+# Copyright (C) 2011 Mark Holmquist
+# Copyright (C) 2011, 2012, 2015, 2016, 2020 Michael Bemmerl
+
+# This script is free software, licensed under the GPLv3, of which you should have received a copy with this software.
+# If you didn't, I apologize, but you'll be able to find it at /usr/share/common-licences/GPL-3 or http://www.gnu.org/licenses/gpl-3.0.txt
+
+# This script will calculate a geohash location for you based on the first price at a market for BTC trades after midnight (UTC).
+# Usually, people use the DJIA for this algorithm, but I didn't think that was nerdy enough :)
+# It will also automagically give you a link to a google map to the location.
+# If you'd like any help with it, don't hesitate to open up an issue at github.
+# Have fun!
+
+from datetime import date, datetime
+import hashlib, urllib.request, urllib.parse, urllib.error, argparse, time, csv, json
+
+parser = argparse.ArgumentParser(description="Calculate a geohash location based on the midnight price for BTC trades.")
+
+subparsers = parser.add_subparsers(help="sub-commands", dest="parser")
+
+globalhash_parser = subparsers.add_parser("globalhash", help="calculate the globalhash")
+globalhash_parser.add_argument('-s', '--symbol', help="symbol of the market (default: krakenUSD)", default="krakenUSD")
+globalhash_parser.add_argument('-m', '--map', help="print URL to a mapping service instead of displaying the raw latitude & longitude.", default="", choices=["google", "osm", "yahoo", "bing"])
+
+graticule_parser = subparsers.add_parser("graticule", help="calculate the geohash of a graticule")
+graticule_parser.add_argument('lat', help="latitude (integer part)", type=int)
+graticule_parser.add_argument('lon', help="longitude (integer part)", type=int)
+graticule_parser.add_argument('-s', '--symbol', help="symbol of the market (default: krakenUSD)", default="krakenUSD")
+graticule_parser.add_argument('-m', '--map', help="print URL to a mapping service instead of displaying the raw latitude & longitude.", default="", choices=["google", "osm", "yahoo", "bing"])
+
+list_symbols_parser = subparsers.add_parser("list-symbols", help="list all available symbols")
+
+def get_midnight(thirtyw_rule):
+    """Calculate unix timestamp of last midnight (UTC)"""
+    utc_unix = time.time()
+    midnight = utc_unix - utc_unix % 86400
+
+    if thirtyw_rule:
+        midnight -= 86400
+
+    return midnight
+
+def get_price(timestamp, symbol):
+    """Returns the first price after the unix date in timestamp"""
+    try:
+        csvinfo = urllib.request.urlopen("https://api.bitcoincharts.com/v1/trades.csv?symbol={0}&start={1}".format(symbol, int(timestamp)))
+    except IOError as e:
+        (errno, strerror) = e.args
+        print("Could not retrieve data from bitcoincharts: " + str(strerror))
+        raise SystemExit
+
+    firstline = csvinfo.read().decode().splitlines()[0]
+    reader = csv.reader([firstline], delimiter=',')
+
+    firstprice = -1
+
+    try:
+        firstprice = next(reader)[1]			# Price is in the second column
+    except StopIteration:
+        raise ValueError("No price data for symbol \"{0}\".".format(symbol))
+    except IndexError:
+        raise ValueError("Symbol \"{0}\" not found. Try another one.".format(symbol))
+
+    return firstprice
+
+def algorithm(date, price):
+    """Calculate the geohash algorithm and return a tupel with the results for latitude & longitude"""
+    thestring = str(date) + "-" + str(price)
+
+    thehash = hashlib.md5(thestring.encode('utf-8')).hexdigest()
+
+    hexnum = (thehash[0:16], thehash[16:32])
+
+    curpow = 1
+    decnum = [0.0, 0.0]
+
+    while curpow <= len(hexnum[0]):
+        decnum[0] += int(hexnum[0][curpow-1], 16) * (1.0 / (16.0 ** curpow))
+        decnum[1] += int(hexnum[1][curpow-1], 16) * (1.0 / (16.0 ** curpow))
+        curpow += 1
+
+    return decnum
+
+def graticule(decnum, latitude, longitude):
+    """Calculate the geohash coordinates for a graticule."""
+    if latitude >= 0:
+        latitude += decnum[0]
+    else:
+        latitude += decnum[0] * -1
+
+    if longitude >= 0:
+        longitude += decnum[1]
+    else:
+        longitude += decnum[1] * -1
+
+    return (latitude, longitude)
+
+def globalhash(decnum):
+    """Calculate the globalhash coordinates."""
+    latitude = decnum[0] * 180 - 90
+    longitude = decnum[1] * 360 - 180
+
+    return (latitude, longitude)
+
+def print_coords(map, latitude, longitude):
+    """Print the coordinates on the console."""
+    url = ""
+
+    if map == "google":
+        url = "https://maps.google.com/maps?q={0},{1}({2})&iwloc=A"
+    elif map == "osm":
+        url = "http://osm.org/?mlat={0}&mlon={1}#map=14/{0}/{1}"
+    elif map == "yahoo":
+        url = "https://maps.yahoo.com/map/?lat={0}&lon={1}&bb={2},{3},{4},{5}"
+    elif map == "bing":
+        url = "https://www.bing.com/maps/?v=2&cp={0}~{1}&lvl=14&dir=0&sp=point.{0}_{1}_{2}"
+
+    if map != "":
+        if map == "yahoo":
+            print(url.format(latitude, longitude, latitude + 0.01, longitude + 0.01, latitude - 0.01, longitude - 0.01))
+        else:
+            print(url.format(latitude, longitude, "Geohash+for+" + str(date.today())))
+    else:
+        print("latitude: " + str(latitude))
+        print("longitude: " + str(longitude))
+
+def list_symbols():
+    jsoninfo = ""
+
+    try:
+        btcinfo = urllib.request.urlopen("https://api.bitcoincharts.com/v1/markets.json")
+        jsoninfo = btcinfo.read()
+        jsoninfo = json.loads(jsoninfo)
+    except IOError as e:
+        (errno, strerror) = e.args
+        print("Could not retrieve data from bitcoincharts: " + str(strerror))
+        raise SystemExit
+
+    print("symbol name".ljust(20) + "last trade")
+    for sym in jsoninfo:
+        print(sym["symbol"].ljust(20) + str(datetime.fromtimestamp(int(sym["latest_trade"]))))
+
+#
+# End of function definitions
+#
+
+args = parser.parse_args()
+
+if args.parser == "graticule":
+    if abs(args.lat) > 90 or abs(args.lon) > 180:
+        raise ValueError("Graticule coordinates out of range.")
+
+    # 30W Time Zone Rule (see http://wiki.xkcd.com/geohashing/30W)
+    midnight = get_midnight(args.lat > -30)
+
+    price = get_price(midnight, args.symbol)
+    decnum = algorithm(date.today(), price)
+
+    coords = graticule(decnum, args.lat, args.lon)
+    print_coords(args.map.lower(), coords[0], coords[1])
+elif args.parser == "globalhash":
+    midnight = get_midnight(True)			# Globalhash is always with 30W rule.
+
+    price = get_price(midnight, args.symbol)
+    decnum = algorithm(date.today(), price)
+
+    coords = globalhash(decnum)
+    print_coords(args.map.lower(), coords[0], coords[1])
+elif args.parser == "list-symbols":
+    list_symbols()