From a483e759c73972a1c270606110353c97e8159b97 Mon Sep 17 00:00:00 2001 From: Michael Bravo Date: Tue, 22 Oct 2019 19:57:27 +0300 Subject: [PATCH 01/58] added details about submodules usage --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 0b7ce4e..7d498fe 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,22 @@ # A collection of useful scripts around Elite Dangerous # +## preparations for usage + +after you have cloned this repository, you need to run + +``` +git submodule init +git submodule update +``` + +and if for some reason you get back to the existing local copy in a while, you may want to run + +``` +git submodule update --remote +``` + +to make sure the submodule(s) have been updated to the latest code + ## edsm-getnearest.py ## ``` -- 2.45.2 From d714231b252139bce7d4477937534fae3827c0c1 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Tue, 12 Nov 2019 10:10:20 +0100 Subject: [PATCH 02/58] updated pyEDSM to fix wonky system names --- pyEDSM | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyEDSM b/pyEDSM index f0a54a7..2877d97 160000 --- a/pyEDSM +++ b/pyEDSM @@ -1 +1 @@ -Subproject commit f0a54a7fe4cbc8c6fdab20fdceb1107e5c50f1bd +Subproject commit 2877d971024845f59fafb4067fd00c9347e6a19e -- 2.45.2 From 77707c1d7824dbe50bf7d7efdb594337b066d260 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Tue, 12 Nov 2019 10:31:51 +0100 Subject: [PATCH 03/58] added README generator :) --- Makefile | 6 +++++- README.md | 4 ++-- generate_docs.sh | 43 +++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 50 insertions(+), 3 deletions(-) create mode 100644 generate_docs.sh diff --git a/Makefile b/Makefile index 0d3617d..c73483f 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,9 @@ -all: exe +all: docs + +docs: + bash generate_docs.sh # requires a windows box exe: pyinstaller.exe -y edsm-getnearest.py + pyinstaller.exe -y explorationtools.py diff --git a/README.md b/README.md index 0b7ce4e..5d234b1 100644 --- a/README.md +++ b/README.md @@ -36,9 +36,9 @@ subcommands: bodycount Returns the number of bodies in a system. Will exit with code 1 on server error and code 2 if the system could not be found in EDSM. - distancebetween Calculates the distance between two systems. Will exit + distancebetween Calculates the distance between two systems. Will exit with code 1 on server error and code 2 if (one of) the - systems could not be found on EDSM. + systems could not be found on EDSM. ``` ``` diff --git a/generate_docs.sh b/generate_docs.sh new file mode 100644 index 0000000..067e220 --- /dev/null +++ b/generate_docs.sh @@ -0,0 +1,43 @@ +#!/usr/bin/env bash +cat > README.md << EOF +# A collection of useful scripts around Elite Dangerous # + +## edsm-getnearest.py ## + +\`\`\` +EOF + +./edsm-getnearest.py -h >> README.md + +cat >> README.md << EOF +\`\`\` + +## explorationtools.py ## + +\`\`\` +EOF + +./explorationtools.py -h >> README.md + + +cat >> README.md << EOF +\`\`\` + +\`\`\` +EOF + +./explorationtools.py bodycount -h >> README.md + + +cat >> README.md << EOF +\`\`\` + +\`\`\` +EOF + +./explorationtools.py distancebetween -h >> README.md + + +cat >> README.md << EOF +\`\`\` +EOF -- 2.45.2 From 24ce59786cdb15e101fe15bc11891fcfcfa87694 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Sun, 24 Nov 2019 22:43:02 +0100 Subject: [PATCH 04/58] updated pyEDSM to current development version --- pyEDSM | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyEDSM b/pyEDSM index 2877d97..105a08a 160000 --- a/pyEDSM +++ b/pyEDSM @@ -1 +1 @@ -Subproject commit 2877d971024845f59fafb4067fd00c9347e6a19e +Subproject commit 105a08a6832f639933889b288806b701d26a1deb -- 2.45.2 From 487168c6fb893c21a018f551b107f4a0aec31f7e Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Sun, 24 Nov 2019 22:58:16 +0100 Subject: [PATCH 05/58] refactoring using Commander model MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Also refactored everything to use the actual models instead of passing strings around. Functionally the same, but … nicer, I guess. --- edsm-getnearest.py | 49 ++++++++++++++++++---------------------------- 1 file changed, 19 insertions(+), 30 deletions(-) diff --git a/edsm-getnearest.py b/edsm-getnearest.py index 9f8548b..8f720d6 100755 --- a/edsm-getnearest.py +++ b/edsm-getnearest.py @@ -5,36 +5,20 @@ import requests import sys import tkinter as tk -from pyEDSM.edsm.exception import ServerError, SystemNotFoundError -from pyEDSM.edsm.models import System, Commander - -class EdsmApiException(Exception): - pass - +from pyEDSM.edsm.exception import CommanderNotFoundError, ServerError, SystemNotFoundError +from pyEDSM.edsm.models import Commander, System # ================================================================================= -def getCmdrCoords (cmdr): - resp = requests.get('https://www.edsm.net/api-logs-v1/get-position?commanderName={}&showCoordinates=1'.format(cmdr)) - if resp.status_code != 200: - raise EdsmApiException('GET /get-position/ {}'.format(resp.status_code)) - try: - ret = resp.json()['coordinates'] - except KeyError: - raise EdsmApiException('Coordinates for CMDR {} not found!'.format(cmdr)) - return ret - def distance (coords1, coords2): return math.sqrt( (coords1['x']-coords2['x'])**2 + (coords1['y']-coords2['y'])**2 + (coords1['z']-coords2['z'])**2 ) def getDistances (system, cmdrs): - systemcoords = System(system).coords distances = {} for cmdr in cmdrs: - cmdrcoords = getCmdrCoords(cmdr) - distances[cmdr] = round(distance(cmdrcoords, systemcoords)) + distances[cmdr] = round(distance(cmdr.currentPosition, system.coords)) return distances # ================================================================================= @@ -45,17 +29,17 @@ def outputGui(): child.grid_remove() child.destroy() try: - system = systemField.get() + system = System(systemField.get()) distances = getDistances(system, cmdrs) nearestCmdr = min(distances,key=distances.get) lbl = tk.Label( - frame, text='nearest CMDR: {} ({} ly from {})'.format(nearestCmdr, - distances[nearestCmdr], system)) + frame, text='nearest CMDR: {} ({} ly from {})'.format(nearestCmdr.name, + distances[nearestCmdr], system.name)) lbl.grid(row=0, columnspan=2) row = 1 for cmdr in distances: row += 1 - lbl = tk.Label(frame, text='{}:'.format(cmdr)) + lbl = tk.Label(frame, text='{}:'.format(cmdr.name)) lbl.grid(row=row, column=0) lbl = tk.Label(frame, text='{} ly'.format(distances[cmdr])) lbl.grid(row=row, column=1) @@ -71,7 +55,7 @@ def outputGui(): lbl.grid(row=0, column=0) systemField = tk.Entry(window, width=50) systemField.grid(row=0, column=1) - systemField.insert(tk.END, system) + systemField.insert(tk.END, system.name) systemField.focus() frame = tk.Frame(window) frame.grid(row=1, columnspan=3) @@ -86,6 +70,9 @@ def outputGui(): def outputText(): try: distances = getDistances(system, cmdrs) + except CommanderNotFoundError as e: + print(e) + sys.exit(1) except ServerError as e: print(e) sys.exit(1) @@ -97,14 +84,14 @@ def outputText(): sys.exit(1) nearestCmdr = min(distances,key=distances.get) if shortOutput: - print('nearest commander: {} ({} ly).'.format(nearestCmdr, + print('nearest commander: {} ({} ly).'.format(nearestCmdr.name, distances[nearestCmdr])) else: - print('nearest CMDR: {} ({} ly from {}).'.format(nearestCmdr, - distances[nearestCmdr], system)) + print('nearest CMDR: {} ({} ly from {}).'.format(nearestCmdr.name, + distances[nearestCmdr], system.name)) print() for cmdr in distances: - print('{}: {} ly'.format(cmdr, distances[cmdr])) + print('{}: {} ly'.format(cmdr.name, distances[cmdr])) sys.exit(0) # ================================================================================= @@ -123,8 +110,10 @@ group.add_argument('--text', action='store_true', help='explicitly give text out args = parser.parse_args() -system = args.system[0].strip().replace(' ', '').replace('', '') -cmdrs = args.cmdrs +system = System(args.system[0].strip().replace(' ', '').replace('', '')) +cmdrs = [] +for name in args.cmdrs: + cmdrs += [Commander(name)] shortOutput = args.short # ================================================================================= -- 2.45.2 From f5a38c4caca50b01ece1f1083f883b0ea2de4be2 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Sun, 5 Jan 2020 19:03:48 +0100 Subject: [PATCH 06/58] implemented argcomplete --- explorationtools.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/explorationtools.py b/explorationtools.py index 25da93c..5924516 100755 --- a/explorationtools.py +++ b/explorationtools.py @@ -1,5 +1,6 @@ #!/usr/bin/env python3 -import argparse +# PYTHON_ARGCOMPLETE_OK +import argcomplete, argparse import math import sys @@ -55,6 +56,7 @@ parser_distance = subparsers.add_parser("distancebetween", + "on EDSM.") parser_distance.add_argument("system", nargs=2) +argcomplete.autocomplete(parser) args = parser.parse_args() # =========================================================================== -- 2.45.2 From f2daa3f68d67d8305266ffb983c1a2a571f7e804 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Sun, 5 Jan 2020 19:04:05 +0100 Subject: [PATCH 07/58] ordering; i like it alphabetically --- explorationtools.py | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/explorationtools.py b/explorationtools.py index 5924516..e5928cc 100755 --- a/explorationtools.py +++ b/explorationtools.py @@ -9,19 +9,6 @@ from pyEDSM.edsm.models import System, Commander # =========================================================================== -def getBodyCount(system): - try: - bodyCount = System(system).bodyCount - except ServerError as e: - print(e) - sys.exit(1) - except NotFoundError as e: - print(e) - sys.exit(2) - else: - print(bodyCount) - sys.exit(0) - def distanceBetween(system1, system2): try: coords1 = System(system1).coords @@ -34,8 +21,21 @@ def distanceBetween(system1, system2): syst.exit(2) else: print(int(round(math.sqrt( (coords1['x']-coords2['x'])**2 - + (coords1['y']-coords2['y'])**2 - + (coords1['z']-coords2['z'])**2 ),0))) + + (coords1['y']-coords2['y'])**2 + + (coords1['z']-coords2['z'])**2 ),0))) + sys.exit(0) + +def getBodyCount(system): + try: + bodyCount = System(system).bodyCount + except ServerError as e: + print(e) + sys.exit(1) + except NotFoundError as e: + print(e) + sys.exit(2) + else: + print(bodyCount) sys.exit(0) # =========================================================================== -- 2.45.2 From d5a794360412902e3c8a529025b2f25d0c0e498c Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Sun, 5 Jan 2020 19:19:56 +0100 Subject: [PATCH 08/58] removed useless line breaks --- generate_docs.sh | 9 --------- 1 file changed, 9 deletions(-) diff --git a/generate_docs.sh b/generate_docs.sh index 067e220..3f09a78 100644 --- a/generate_docs.sh +++ b/generate_docs.sh @@ -6,9 +6,7 @@ cat > README.md << EOF \`\`\` EOF - ./edsm-getnearest.py -h >> README.md - cat >> README.md << EOF \`\`\` @@ -16,25 +14,18 @@ cat >> README.md << EOF \`\`\` EOF - ./explorationtools.py -h >> README.md - - cat >> README.md << EOF \`\`\` \`\`\` EOF - ./explorationtools.py bodycount -h >> README.md - - cat >> README.md << EOF \`\`\` \`\`\` EOF - ./explorationtools.py distancebetween -h >> README.md -- 2.45.2 From c255277e8988707ceab2ef1aed7b4b6c79717f95 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Sun, 5 Jan 2020 19:20:20 +0100 Subject: [PATCH 09/58] explorationtools: added `findCommander` MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Let’s you, duh, find a Commander’s last known system if they are on EDSM and have their flight logs public. --- README.md | 17 +++++++++++++++-- explorationtools.py | 20 ++++++++++++++++++++ generate_docs.sh | 6 +++++- 3 files changed, 40 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5d234b1..5669b94 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ optional arguments: ## explorationtools.py ## ``` -usage: explorationtools.py [-h] {bodycount,distancebetween} ... +usage: explorationtools.py [-h] {bodycount,distancebetween,findCommander} ... A collection of tools useful for exploration. @@ -31,7 +31,7 @@ optional arguments: -h, --help show this help message and exit subcommands: - {bodycount,distancebetween} + {bodycount,distancebetween,findCommander} sub-command help bodycount Returns the number of bodies in a system. Will exit with code 1 on server error and code 2 if the system @@ -39,6 +39,9 @@ subcommands: distancebetween Calculates the distance between two systems. Will exit with code 1 on server error and code 2 if (one of) the systems could not be found on EDSM. + findCommander Attempts to find a CMDR’s last known position. Will + exit with code 1 on server error and code 2 if the + CMDR could not be found on EDSM. ``` ``` @@ -60,3 +63,13 @@ positional arguments: optional arguments: -h, --help show this help message and exit ``` + +``` +usage: explorationtools.py findCommander [-h] name + +positional arguments: + name + +optional arguments: + -h, --help show this help message and exit +``` diff --git a/explorationtools.py b/explorationtools.py index e5928cc..180e5a5 100755 --- a/explorationtools.py +++ b/explorationtools.py @@ -25,6 +25,19 @@ def distanceBetween(system1, system2): + (coords1['z']-coords2['z'])**2 ),0))) sys.exit(0) +def findCommander(name): + try: + currentSystem = Commander(name).currentSystem + except ServerError as e: + print(e) + sys.exit(1) + except NotFoundError as e: + print(e) + sys.exit(2) + else: + print(currentSystem) + sys.exit(0) + def getBodyCount(system): try: bodyCount = System(system).bodyCount @@ -56,6 +69,11 @@ parser_distance = subparsers.add_parser("distancebetween", + "on EDSM.") parser_distance.add_argument("system", nargs=2) +parser_find = subparsers.add_parser("findCommander", + help="Attempts to find a CMDR’s last known position. Will exit with code 1 " + + "on server error and code 2 if the CMDR could not be found on EDSM.") +parser_find.add_argument("name") + argcomplete.autocomplete(parser) args = parser.parse_args() @@ -65,3 +83,5 @@ if args.subCommand == "bodycount": getBodyCount(args.system[0]) elif args.subCommand == "distancebetween": distanceBetween(args.system[0], args.system[1]) +elif args.subCommand == "findCommander": + findCommander(args.name) diff --git a/generate_docs.sh b/generate_docs.sh index 3f09a78..f914ca9 100644 --- a/generate_docs.sh +++ b/generate_docs.sh @@ -27,8 +27,12 @@ cat >> README.md << EOF \`\`\` EOF ./explorationtools.py distancebetween -h >> README.md +cat >> README.md << EOF +\`\`\` - +\`\`\` +EOF +./explorationtools.py findCommander -h >> README.md cat >> README.md << EOF \`\`\` EOF -- 2.45.2 From 0b32f1fb7f714c22fb4bac3f33c265e9bb13aca6 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Sun, 5 Jan 2020 19:21:57 +0100 Subject: [PATCH 10/58] updated to latest pyEDSM --- pyEDSM | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyEDSM b/pyEDSM index 105a08a..3909728 160000 --- a/pyEDSM +++ b/pyEDSM @@ -1 +1 @@ -Subproject commit 105a08a6832f639933889b288806b701d26a1deb +Subproject commit 3909728056f06836e77f92c31b36c58e59f89360 -- 2.45.2 From d062d90307ff18127feb594891f9ba4179b0d7dd Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Mon, 6 Jan 2020 17:20:37 +0100 Subject: [PATCH 11/58] refactoring for less duplicate code --- explorationtools.py | 65 ++++++++++++++++----------------------------- 1 file changed, 23 insertions(+), 42 deletions(-) diff --git a/explorationtools.py b/explorationtools.py index 180e5a5..3001085 100755 --- a/explorationtools.py +++ b/explorationtools.py @@ -10,46 +10,17 @@ from pyEDSM.edsm.models import System, Commander # =========================================================================== def distanceBetween(system1, system2): - try: - coords1 = System(system1).coords - coords2 = System(system2).coords - except ServerError as e: - print(e) - sys.exit(1) - except NotFoundError as e: - print(e) - syst.exit(2) - else: - print(int(round(math.sqrt( (coords1['x']-coords2['x'])**2 + coords1 = System(system1).coords + coords2 = System(system2).coords + return int(round(math.sqrt( (coords1['x']-coords2['x'])**2 + (coords1['y']-coords2['y'])**2 - + (coords1['z']-coords2['z'])**2 ),0))) - sys.exit(0) + + (coords1['z']-coords2['z'])**2 ),0)) def findCommander(name): - try: - currentSystem = Commander(name).currentSystem - except ServerError as e: - print(e) - sys.exit(1) - except NotFoundError as e: - print(e) - sys.exit(2) - else: - print(currentSystem) - sys.exit(0) + return Commander(name).currentSystem def getBodyCount(system): - try: - bodyCount = System(system).bodyCount - except ServerError as e: - print(e) - sys.exit(1) - except NotFoundError as e: - print(e) - sys.exit(2) - else: - print(bodyCount) - sys.exit(0) + return System(system).bodyCount # =========================================================================== @@ -69,7 +40,7 @@ parser_distance = subparsers.add_parser("distancebetween", + "on EDSM.") parser_distance.add_argument("system", nargs=2) -parser_find = subparsers.add_parser("findCommander", +parser_find = subparsers.add_parser("findcommander", help="Attempts to find a CMDR’s last known position. Will exit with code 1 " + "on server error and code 2 if the CMDR could not be found on EDSM.") parser_find.add_argument("name") @@ -79,9 +50,19 @@ args = parser.parse_args() # =========================================================================== -if args.subCommand == "bodycount": - getBodyCount(args.system[0]) -elif args.subCommand == "distancebetween": - distanceBetween(args.system[0], args.system[1]) -elif args.subCommand == "findCommander": - findCommander(args.name) +try: + if args.subCommand == "bodycount": + out = getBodyCount(args.system[0]) + elif args.subCommand == "distancebetween": + out = distanceBetween(args.system[0], args.system[1]) + elif args.subCommand == "findcommander": + out = findCommander(args.name) +except ServerError as e: + print(e) + sys.exit(1) +except NotFoundError as e: + print(e) + sys.exit(2) +else: + print(out) + sys.exit(0) -- 2.45.2 From 1dd8958ed58cc8346930c6fece5a84e8d274e908 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Mon, 6 Jan 2020 17:24:57 +0100 Subject: [PATCH 12/58] added optional API key to findcommander --- explorationtools.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/explorationtools.py b/explorationtools.py index 3001085..de6804c 100755 --- a/explorationtools.py +++ b/explorationtools.py @@ -16,8 +16,8 @@ def distanceBetween(system1, system2): + (coords1['y']-coords2['y'])**2 + (coords1['z']-coords2['z'])**2 ),0)) -def findCommander(name): - return Commander(name).currentSystem +def findCommander(name, apikey): + return Commander(name, apikey).currentSystem def getBodyCount(system): return System(system).bodyCount @@ -44,6 +44,8 @@ parser_find = subparsers.add_parser("findcommander", help="Attempts to find a CMDR’s last known position. Will exit with code 1 " + "on server error and code 2 if the CMDR could not be found on EDSM.") parser_find.add_argument("name") +parser_find.add_argument("apikey", default="", nargs="?", + help="the commander’s EDSM API key. Can be empty for public profiles.") argcomplete.autocomplete(parser) args = parser.parse_args() @@ -56,7 +58,7 @@ try: elif args.subCommand == "distancebetween": out = distanceBetween(args.system[0], args.system[1]) elif args.subCommand == "findcommander": - out = findCommander(args.name) + out = findCommander(args.name, args.apikey) except ServerError as e: print(e) sys.exit(1) -- 2.45.2 From 1508ccf5c507d55ea9d9cb6ee0e0c702acabb758 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Mon, 6 Jan 2020 17:28:30 +0100 Subject: [PATCH 13/58] added help fluff text for arguments --- explorationtools.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/explorationtools.py b/explorationtools.py index de6804c..2cafd00 100755 --- a/explorationtools.py +++ b/explorationtools.py @@ -32,18 +32,18 @@ subparsers = parser.add_subparsers(title="subcommands", help="sub-command help", parser_bodycount = subparsers.add_parser("bodycount", help="Returns the number of bodies in a system. Will exit with code 1 on " + "server error and code 2 if the system could not be found in EDSM.") -parser_bodycount.add_argument("system", nargs=1) +parser_bodycount.add_argument("system", nargs=1, help="system to query") parser_distance = subparsers.add_parser("distancebetween", help="Calculates the distance between two systems. Will exit with code 1 " + "on server error and code 2 if (one of) the systems could not be found " + "on EDSM.") -parser_distance.add_argument("system", nargs=2) +parser_distance.add_argument("system", nargs=2, help="the systems to measure") parser_find = subparsers.add_parser("findcommander", help="Attempts to find a CMDR’s last known position. Will exit with code 1 " + "on server error and code 2 if the CMDR could not be found on EDSM.") -parser_find.add_argument("name") +parser_find.add_argument("name", help="the commander in question") parser_find.add_argument("apikey", default="", nargs="?", help="the commander’s EDSM API key. Can be empty for public profiles.") -- 2.45.2 From 1f113611d4d1267cdfe0b1565c3a1b376ec9d5e1 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Mon, 6 Jan 2020 17:28:40 +0100 Subject: [PATCH 14/58] regenerated docs --- README.md | 15 ++++++++------- generate_docs.sh | 2 +- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 5669b94..654df79 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ optional arguments: ## explorationtools.py ## ``` -usage: explorationtools.py [-h] {bodycount,distancebetween,findCommander} ... +usage: explorationtools.py [-h] {bodycount,distancebetween,findcommander} ... A collection of tools useful for exploration. @@ -31,7 +31,7 @@ optional arguments: -h, --help show this help message and exit subcommands: - {bodycount,distancebetween,findCommander} + {bodycount,distancebetween,findcommander} sub-command help bodycount Returns the number of bodies in a system. Will exit with code 1 on server error and code 2 if the system @@ -39,7 +39,7 @@ subcommands: distancebetween Calculates the distance between two systems. Will exit with code 1 on server error and code 2 if (one of) the systems could not be found on EDSM. - findCommander Attempts to find a CMDR’s last known position. Will + findcommander Attempts to find a CMDR’s last known position. Will exit with code 1 on server error and code 2 if the CMDR could not be found on EDSM. ``` @@ -48,7 +48,7 @@ subcommands: usage: explorationtools.py bodycount [-h] system positional arguments: - system + system system to query optional arguments: -h, --help show this help message and exit @@ -58,17 +58,18 @@ optional arguments: usage: explorationtools.py distancebetween [-h] system system positional arguments: - system + system the systems to measure optional arguments: -h, --help show this help message and exit ``` ``` -usage: explorationtools.py findCommander [-h] name +usage: explorationtools.py findcommander [-h] name [apikey] positional arguments: - name + name the commander in question + apikey the commander’s EDSM API key. Can be empty for public profiles. optional arguments: -h, --help show this help message and exit diff --git a/generate_docs.sh b/generate_docs.sh index f914ca9..730ef78 100644 --- a/generate_docs.sh +++ b/generate_docs.sh @@ -32,7 +32,7 @@ cat >> README.md << EOF \`\`\` EOF -./explorationtools.py findCommander -h >> README.md +./explorationtools.py findcommander -h >> README.md cat >> README.md << EOF \`\`\` EOF -- 2.45.2 From dfeb6993b05ade297d118b6922434555fe423b91 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Tue, 7 Jan 2020 17:27:31 +0100 Subject: [PATCH 15/58] added option to get profileURL to `findcommander` --- README.md | 4 +++- explorationtools.py | 13 ++++++++++++- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 654df79..82b1d9c 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,7 @@ optional arguments: ``` ``` -usage: explorationtools.py findcommander [-h] name [apikey] +usage: explorationtools.py findcommander [-h] [--system | --url] name [apikey] positional arguments: name the commander in question @@ -73,4 +73,6 @@ positional arguments: optional arguments: -h, --help show this help message and exit + --system output the commander’s last known system (default) + --url output the commander’s profile URL ``` diff --git a/explorationtools.py b/explorationtools.py index 2cafd00..6aa3456 100755 --- a/explorationtools.py +++ b/explorationtools.py @@ -19,6 +19,9 @@ def distanceBetween(system1, system2): def findCommander(name, apikey): return Commander(name, apikey).currentSystem +def getProfileUrl(name, apikey): + return Commander(name, apikey).profileUrl + def getBodyCount(system): return System(system).bodyCount @@ -43,6 +46,11 @@ parser_distance.add_argument("system", nargs=2, help="the systems to measure") parser_find = subparsers.add_parser("findcommander", help="Attempts to find a CMDR’s last known position. Will exit with code 1 " + "on server error and code 2 if the CMDR could not be found on EDSM.") +group = parser_find.add_mutually_exclusive_group(required=False) +group.add_argument('--system', action='store_true', + help='output the commander’s last known system (default)') +group.add_argument('--url', action='store_true', + help='output the commander’s profile URL') parser_find.add_argument("name", help="the commander in question") parser_find.add_argument("apikey", default="", nargs="?", help="the commander’s EDSM API key. Can be empty for public profiles.") @@ -58,7 +66,10 @@ try: elif args.subCommand == "distancebetween": out = distanceBetween(args.system[0], args.system[1]) elif args.subCommand == "findcommander": - out = findCommander(args.name, args.apikey) + if args.url: + out = getProfileUrl(args.name, args.apikey) + else: + out = findCommander(args.name, args.apikey) except ServerError as e: print(e) sys.exit(1) -- 2.45.2 From db34c8fcb8ddcc3d5a3328ed7e4f1ca481aa297c Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Tue, 7 Jan 2020 20:53:34 +0100 Subject: [PATCH 16/58] Revert "implemented argcomplete" This reverts commit f5a38c4caca50b01ece1f1083f883b0ea2de4be2. --- explorationtools.py | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/explorationtools.py b/explorationtools.py index 6aa3456..d8fbb86 100755 --- a/explorationtools.py +++ b/explorationtools.py @@ -1,6 +1,5 @@ #!/usr/bin/env python3 -# PYTHON_ARGCOMPLETE_OK -import argcomplete, argparse +import argparse import math import sys @@ -55,7 +54,6 @@ parser_find.add_argument("name", help="the commander in question") parser_find.add_argument("apikey", default="", nargs="?", help="the commander’s EDSM API key. Can be empty for public profiles.") -argcomplete.autocomplete(parser) args = parser.parse_args() # =========================================================================== -- 2.45.2 From f2769f19ea0988e59d6c6af0236838a0242fcd58 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Wed, 8 Jan 2020 08:24:31 +0100 Subject: [PATCH 17/58] Revert "Revert "implemented argcomplete"" This reverts commit db34c8fcb8ddcc3d5a3328ed7e4f1ca481aa297c. --- explorationtools.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/explorationtools.py b/explorationtools.py index d8fbb86..6aa3456 100755 --- a/explorationtools.py +++ b/explorationtools.py @@ -1,5 +1,6 @@ #!/usr/bin/env python3 -import argparse +# PYTHON_ARGCOMPLETE_OK +import argcomplete, argparse import math import sys @@ -54,6 +55,7 @@ parser_find.add_argument("name", help="the commander in question") parser_find.add_argument("apikey", default="", nargs="?", help="the commander’s EDSM API key. Can be empty for public profiles.") +argcomplete.autocomplete(parser) args = parser.parse_args() # =========================================================================== -- 2.45.2 From ce5817faab4d10e5f177c83dc3c0ca7d2cf7ea9e Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Wed, 8 Jan 2020 08:30:27 +0100 Subject: [PATCH 18/58] properly documented required packages --- README.md | 16 ++++++++++++++++ generate_docs.sh | 16 ++++++++++++++++ requirements.txt | 3 +++ 3 files changed, 35 insertions(+) create mode 100644 requirements.txt diff --git a/README.md b/README.md index 82b1d9c..00e3f95 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,16 @@ # A collection of useful scripts around Elite Dangerous # +## Requirements ## + +* argcomplete +* argparse +* requests +* Tkinter + +You probably want to install your distribution/OS package for Tkinter instead of +using pip. Then do the good old `pip install --user -r requirements.txt` or +`pip3 install --user -r requirements.txt`. + ## edsm-getnearest.py ## ``` @@ -76,3 +87,8 @@ optional arguments: --system output the commander’s last known system (default) --url output the commander’s profile URL ``` + +## Need Help / Want to Contribute? ## + +Just [file an issue](https://github.com/alterNERDtive/elite-scripts/issues/new) +here or [hop into Discord](https://discord.gg/uUKFdW) if that is your thing. diff --git a/generate_docs.sh b/generate_docs.sh index 730ef78..fc62a6c 100644 --- a/generate_docs.sh +++ b/generate_docs.sh @@ -2,6 +2,17 @@ cat > README.md << EOF # A collection of useful scripts around Elite Dangerous # +## Requirements ## + +* argcomplete +* argparse +* requests +* Tkinter + +You probably want to install your distribution/OS package for Tkinter instead of +using pip. Then do the good old \`pip install --user -r requirements.txt\` or +\`pip3 install --user -r requirements.txt\`. + ## edsm-getnearest.py ## \`\`\` @@ -35,4 +46,9 @@ EOF ./explorationtools.py findcommander -h >> README.md cat >> README.md << EOF \`\`\` + +## Need Help / Want to Contribute? ## + +Just [file an issue](https://github.com/alterNERDtive/elite-scripts/issues/new) +here or [hop into Discord](https://discord.gg/uUKFdW) if that is your thing. EOF diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..d1713fb --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +argcomplete +argparse +requests -- 2.45.2 From 3def9ad3c3ca49a34f6570b13f02dc94adc96616 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Wed, 8 Jan 2020 08:49:09 +0100 Subject: [PATCH 19/58] some refactoring --- explorationtools.py | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/explorationtools.py b/explorationtools.py index 6aa3456..a84ea59 100755 --- a/explorationtools.py +++ b/explorationtools.py @@ -9,6 +9,9 @@ from pyEDSM.edsm.models import System, Commander # =========================================================================== +def getBodyCount(system): + return System(system).bodyCount + def distanceBetween(system1, system2): coords1 = System(system1).coords coords2 = System(system2).coords @@ -16,14 +19,11 @@ def distanceBetween(system1, system2): + (coords1['y']-coords2['y'])**2 + (coords1['z']-coords2['z'])**2 ),0)) -def findCommander(name, apikey): - return Commander(name, apikey).currentSystem - -def getProfileUrl(name, apikey): +def getCommanderProfileUrl(name, apikey): return Commander(name, apikey).profileUrl -def getBodyCount(system): - return System(system).bodyCount +def getCommanderSystem(name, apikey): + return Commander(name, apikey).currentSystem # =========================================================================== @@ -67,9 +67,9 @@ try: out = distanceBetween(args.system[0], args.system[1]) elif args.subCommand == "findcommander": if args.url: - out = getProfileUrl(args.name, args.apikey) + out = getCommanderProfileUrl(args.name, args.apikey) else: - out = findCommander(args.name, args.apikey) + out = getCommanderSystem(args.name, args.apikey) except ServerError as e: print(e) sys.exit(1) -- 2.45.2 From 6ff10430eb698689789375f1ebe9be1a62ca30f7 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Wed, 8 Jan 2020 08:49:53 +0100 Subject: [PATCH 20/58] added `--coords` option to `findcommander` --- README.md | 5 ++++- explorationtools.py | 13 ++++++++++++- 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 00e3f95..fc2b661 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,8 @@ optional arguments: ``` ``` -usage: explorationtools.py findcommander [-h] [--system | --url] name [apikey] +usage: explorationtools.py findcommander [-h] [--system | --coords | --url] + name [apikey] positional arguments: name the commander in question @@ -85,6 +86,8 @@ positional arguments: optional arguments: -h, --help show this help message and exit --system output the commander’s last known system (default) + --coords output the commander’s last known position in {x,y,z} + coordinates --url output the commander’s profile URL ``` diff --git a/explorationtools.py b/explorationtools.py index a84ea59..32ea660 100755 --- a/explorationtools.py +++ b/explorationtools.py @@ -19,6 +19,13 @@ def distanceBetween(system1, system2): + (coords1['y']-coords2['y'])**2 + (coords1['z']-coords2['z'])**2 ),0)) +def getCommanderPosition(name, apikey): + coords = Commander(name, apikey).currentPosition + ret = "" + for k in coords: + ret += "{}: {}, ".format(k, coords[k]) + return ret[:-2] + def getCommanderProfileUrl(name, apikey): return Commander(name, apikey).profileUrl @@ -49,6 +56,8 @@ parser_find = subparsers.add_parser("findcommander", group = parser_find.add_mutually_exclusive_group(required=False) group.add_argument('--system', action='store_true', help='output the commander’s last known system (default)') +group.add_argument('--coords', action='store_true', + help='output the commander’s last known position in {x,y,z} coordinates') group.add_argument('--url', action='store_true', help='output the commander’s profile URL') parser_find.add_argument("name", help="the commander in question") @@ -66,7 +75,9 @@ try: elif args.subCommand == "distancebetween": out = distanceBetween(args.system[0], args.system[1]) elif args.subCommand == "findcommander": - if args.url: + if args.coords: + out = getCommanderPosition(args.name, args.apikey) + elif args.url: out = getCommanderProfileUrl(args.name, args.apikey) else: out = getCommanderSystem(args.name, args.apikey) -- 2.45.2 From 2ccdd684a24946eaae5e07c4361cfcf635fcfe46 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Wed, 8 Jan 2020 08:55:37 +0100 Subject: [PATCH 21/58] some more refactoring; output format for cords might change --- explorationtools.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/explorationtools.py b/explorationtools.py index 32ea660..0884717 100755 --- a/explorationtools.py +++ b/explorationtools.py @@ -20,11 +20,7 @@ def distanceBetween(system1, system2): + (coords1['z']-coords2['z'])**2 ),0)) def getCommanderPosition(name, apikey): - coords = Commander(name, apikey).currentPosition - ret = "" - for k in coords: - ret += "{}: {}, ".format(k, coords[k]) - return ret[:-2] + return Commander(name, apikey).currentPosition def getCommanderProfileUrl(name, apikey): return Commander(name, apikey).profileUrl @@ -76,7 +72,11 @@ try: out = distanceBetween(args.system[0], args.system[1]) elif args.subCommand == "findcommander": if args.coords: - out = getCommanderPosition(args.name, args.apikey) + coords = getCommanderPosition(args.name, args.apikey) + out = "" + for k in coords: + out += "{}: {}, ".format(k, coords[k]) + out = out[:-2] elif args.url: out = getCommanderProfileUrl(args.name, args.apikey) else: -- 2.45.2 From 06f4ba643b9efee8ad2cf33c5ebd588a8bcd75e1 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Wed, 8 Jan 2020 09:33:55 +0100 Subject: [PATCH 22/58] Revert "some more refactoring; output format for cords might change" This reverts commit 2ccdd684a24946eaae5e07c4361cfcf635fcfe46. --- explorationtools.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/explorationtools.py b/explorationtools.py index 0884717..32ea660 100755 --- a/explorationtools.py +++ b/explorationtools.py @@ -20,7 +20,11 @@ def distanceBetween(system1, system2): + (coords1['z']-coords2['z'])**2 ),0)) def getCommanderPosition(name, apikey): - return Commander(name, apikey).currentPosition + coords = Commander(name, apikey).currentPosition + ret = "" + for k in coords: + ret += "{}: {}, ".format(k, coords[k]) + return ret[:-2] def getCommanderProfileUrl(name, apikey): return Commander(name, apikey).profileUrl @@ -72,11 +76,7 @@ try: out = distanceBetween(args.system[0], args.system[1]) elif args.subCommand == "findcommander": if args.coords: - coords = getCommanderPosition(args.name, args.apikey) - out = "" - for k in coords: - out += "{}: {}, ".format(k, coords[k]) - out = out[:-2] + out = getCommanderPosition(args.name, args.apikey) elif args.url: out = getCommanderProfileUrl(args.name, args.apikey) else: -- 2.45.2 From 5ff05579565d7f0cd9f66119473cbabf10b93f02 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Wed, 8 Jan 2020 11:29:18 +0100 Subject: [PATCH 23/58] updated to current pyEDSM MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit … and now making full use of the new `distanceTo` stuff :) --- edsm-getnearest.py | 17 ++++++++--------- explorationtools.py | 6 +----- pyEDSM | 2 +- 3 files changed, 10 insertions(+), 15 deletions(-) diff --git a/edsm-getnearest.py b/edsm-getnearest.py index 8f720d6..a769db1 100755 --- a/edsm-getnearest.py +++ b/edsm-getnearest.py @@ -10,15 +10,10 @@ from pyEDSM.edsm.models import Commander, System # ================================================================================= -def distance (coords1, coords2): - return math.sqrt( (coords1['x']-coords2['x'])**2 - + (coords1['y']-coords2['y'])**2 - + (coords1['z']-coords2['z'])**2 ) - -def getDistances (system, cmdrs): +def getDistances (system, cmdrs, roundTo=2): distances = {} for cmdr in cmdrs: - distances[cmdr] = round(distance(cmdr.currentPosition, system.coords)) + distances[cmdr] = system.distanceTo(cmdr, roundTo=roundTo) return distances # ================================================================================= @@ -68,8 +63,12 @@ def outputGui(): # ================================================================================= def outputText(): + if shortOutput: + roundTo=0 + else: + roundTo=2 try: - distances = getDistances(system, cmdrs) + distances = getDistances(system, cmdrs, roundTo=roundTo) except CommanderNotFoundError as e: print(e) sys.exit(1) @@ -85,7 +84,7 @@ def outputText(): nearestCmdr = min(distances,key=distances.get) if shortOutput: print('nearest commander: {} ({} ly).'.format(nearestCmdr.name, - distances[nearestCmdr])) + int(distances[nearestCmdr]))) else: print('nearest CMDR: {} ({} ly from {}).'.format(nearestCmdr.name, distances[nearestCmdr], system.name)) diff --git a/explorationtools.py b/explorationtools.py index 32ea660..267d9e2 100755 --- a/explorationtools.py +++ b/explorationtools.py @@ -13,11 +13,7 @@ def getBodyCount(system): return System(system).bodyCount def distanceBetween(system1, system2): - coords1 = System(system1).coords - coords2 = System(system2).coords - return int(round(math.sqrt( (coords1['x']-coords2['x'])**2 - + (coords1['y']-coords2['y'])**2 - + (coords1['z']-coords2['z'])**2 ),0)) + return System(system1).distanceTo(System(system2)) def getCommanderPosition(name, apikey): coords = Commander(name, apikey).currentPosition diff --git a/pyEDSM b/pyEDSM index 3909728..ef36127 160000 --- a/pyEDSM +++ b/pyEDSM @@ -1 +1 @@ -Subproject commit 3909728056f06836e77f92c31b36c58e59f89360 +Subproject commit ef36127bb92786f8460a14f8c34039104bbd873b -- 2.45.2 From 999f408ab2aaa0d3ad4387e878ca83a619f1deca Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Wed, 8 Jan 2020 13:45:08 +0100 Subject: [PATCH 24/58] updated to current pyEDSM --- pyEDSM | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyEDSM b/pyEDSM index ef36127..318ad17 160000 --- a/pyEDSM +++ b/pyEDSM @@ -1 +1 @@ -Subproject commit ef36127bb92786f8460a14f8c34039104bbd873b +Subproject commit 318ad170111f95395a4cf9c16222f180ab4c1c0a -- 2.45.2 From 6d4ee49011030337fc9649a66f834549c6504827 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Wed, 8 Jan 2020 13:45:31 +0100 Subject: [PATCH 25/58] distance now pulls both systems in one call --- explorationtools.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/explorationtools.py b/explorationtools.py index 267d9e2..3e1a143 100755 --- a/explorationtools.py +++ b/explorationtools.py @@ -13,7 +13,8 @@ def getBodyCount(system): return System(system).bodyCount def distanceBetween(system1, system2): - return System(system1).distanceTo(System(system2)) + systems = System.getSystems(system1, system2) + return systems[0].distanceTo(systems[1]) def getCommanderPosition(name, apikey): coords = Commander(name, apikey).currentPosition -- 2.45.2 From a3069a4c6a364617b130b9b7c5207f5f055cc9b7 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Wed, 8 Jan 2020 14:54:39 +0100 Subject: [PATCH 26/58] new command: `systemlist` Runs an EDSM search query for systems starting with the given string. --- README.md | 18 ++++++++++++++++-- explorationtools.py | 16 ++++++++++++++++ generate_docs.sh | 6 ++++++ pyEDSM | 2 +- 4 files changed, 39 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index fc2b661..e99211c 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,9 @@ optional arguments: ## explorationtools.py ## ``` -usage: explorationtools.py [-h] {bodycount,distancebetween,findcommander} ... +usage: explorationtools.py [-h] + {bodycount,distancebetween,findcommander,systemlist} + ... A collection of tools useful for exploration. @@ -42,7 +44,7 @@ optional arguments: -h, --help show this help message and exit subcommands: - {bodycount,distancebetween,findcommander} + {bodycount,distancebetween,findcommander,systemlist} sub-command help bodycount Returns the number of bodies in a system. Will exit with code 1 on server error and code 2 if the system @@ -53,6 +55,8 @@ subcommands: findcommander Attempts to find a CMDR’s last known position. Will exit with code 1 on server error and code 2 if the CMDR could not be found on EDSM. + systemlist Pulls all system names starting with the given string + from EDSM ``` ``` @@ -91,6 +95,16 @@ optional arguments: --url output the commander’s profile URL ``` +``` +usage: explorationtools.py systemlist [-h] partialsystem + +positional arguments: + partialsystem the partial system name to query against + +optional arguments: + -h, --help show this help message and exit +``` + ## Need Help / Want to Contribute? ## Just [file an issue](https://github.com/alterNERDtive/elite-scripts/issues/new) diff --git a/explorationtools.py b/explorationtools.py index 3e1a143..4a521c5 100755 --- a/explorationtools.py +++ b/explorationtools.py @@ -29,6 +29,15 @@ def getCommanderProfileUrl(name, apikey): def getCommanderSystem(name, apikey): return Commander(name, apikey).currentSystem +def getSystemList(name): + ret = "" + + systems = System.getSystems(name) + for system in systems: + ret += "{}\n".format(system.name) + + return ret[:-1] + # =========================================================================== parser = argparse.ArgumentParser(description="A collection of tools useful for " @@ -61,6 +70,11 @@ parser_find.add_argument("name", help="the commander in question") parser_find.add_argument("apikey", default="", nargs="?", help="the commander’s EDSM API key. Can be empty for public profiles.") +parser_bodycount = subparsers.add_parser("systemlist", + help="Pulls all system names starting with the given string from EDSM") +parser_bodycount.add_argument("partialsystem", nargs=1, + help="the partial system name to query against") + argcomplete.autocomplete(parser) args = parser.parse_args() @@ -78,6 +92,8 @@ try: out = getCommanderProfileUrl(args.name, args.apikey) else: out = getCommanderSystem(args.name, args.apikey) + elif args.subCommand == "systemlist": + out = getSystemList(args.partialsystem) except ServerError as e: print(e) sys.exit(1) diff --git a/generate_docs.sh b/generate_docs.sh index fc62a6c..727973f 100644 --- a/generate_docs.sh +++ b/generate_docs.sh @@ -47,6 +47,12 @@ EOF cat >> README.md << EOF \`\`\` +\`\`\` +EOF +./explorationtools.py systemlist -h >> README.md +cat >> README.md << EOF +\`\`\` + ## Need Help / Want to Contribute? ## Just [file an issue](https://github.com/alterNERDtive/elite-scripts/issues/new) diff --git a/pyEDSM b/pyEDSM index 318ad17..b476c34 160000 --- a/pyEDSM +++ b/pyEDSM @@ -1 +1 @@ -Subproject commit 318ad170111f95395a4cf9c16222f180ab4c1c0a +Subproject commit b476c34de50e6a76f93a522140acbf3536f18728 -- 2.45.2 From 51cc55cda91b38872c6d4ffe50a1b383c14476eb Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Wed, 8 Jan 2020 15:03:46 +0100 Subject: [PATCH 27/58] added .gitignore --- .gitignore | 1 + 1 file changed, 1 insertion(+) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..567609b --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +build/ -- 2.45.2 From 2c6695e9e6032409a9b42ed22d47732227c0cd5a Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Wed, 8 Jan 2020 15:04:05 +0100 Subject: [PATCH 28/58] updated Makefile --- Makefile | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/Makefile b/Makefile index c73483f..88ff5c5 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,10 @@ all: docs +zipfile = elite-scripts.zip + +clean: + rm -f $(zipfile) + docs: bash generate_docs.sh @@ -7,3 +12,7 @@ docs: exe: pyinstaller.exe -y edsm-getnearest.py pyinstaller.exe -y explorationtools.py + +release: clean + rsync -avz gezocks:/mnt/d/git/elite-scripts/dist/ build/ + cd build && zip -r ../$(zipfile) * -- 2.45.2 From 61f6051c206b6e9eb55043b3c99b87530d0eaf2c Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Wed, 8 Jan 2020 15:13:10 +0100 Subject: [PATCH 29/58] updated README --- README.md | 15 +++++++++++++-- generate_docs.sh | 15 +++++++++++++-- 2 files changed, 26 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e99211c..2c560bb 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,18 @@ You probably want to install your distribution/OS package for Tkinter instead of using pip. Then do the good old `pip install --user -r requirements.txt` or `pip3 install --user -r requirements.txt`. -## edsm-getnearest.py ## +## Pre-Compiled Version (Windows) ## + +If you check the +[releases](https://github.com/alterNERDtive/elite-scripts/releases) you’ll find +a .zip file with pre-compiled scripts that don’t need Python installed. Mostly +a) for saving myself some hassle and b) because that’s easier to distribute with +my +[VoiceAttack profiles](https://github.com/alterNERDtive/VoiceAttack-profiles). + +## Scripts ## + +### edsm-getnearest.py ### ``` usage: edsm-getnearest.py [-h] --system SYSTEM [--short] [--gui | --text] @@ -31,7 +42,7 @@ optional arguments: --text explicitly give text output ``` -## explorationtools.py ## +### explorationtools.py ### ``` usage: explorationtools.py [-h] diff --git a/generate_docs.sh b/generate_docs.sh index 727973f..76e148c 100644 --- a/generate_docs.sh +++ b/generate_docs.sh @@ -13,7 +13,18 @@ You probably want to install your distribution/OS package for Tkinter instead of using pip. Then do the good old \`pip install --user -r requirements.txt\` or \`pip3 install --user -r requirements.txt\`. -## edsm-getnearest.py ## +## Pre-Compiled Version (Windows) ## + +If you check the +[releases](https://github.com/alterNERDtive/elite-scripts/releases) you’ll find +a .zip file with pre-compiled scripts that don’t need Python installed. Mostly +a) for saving myself some hassle and b) because that’s easier to distribute with +my +[VoiceAttack profiles](https://github.com/alterNERDtive/VoiceAttack-profiles). + +## Scripts ## + +### edsm-getnearest.py ### \`\`\` EOF @@ -21,7 +32,7 @@ EOF cat >> README.md << EOF \`\`\` -## explorationtools.py ## +### explorationtools.py ### \`\`\` EOF -- 2.45.2 From a3b5a82e24a81780c920684cfd23091fd386e4d5 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Wed, 8 Jan 2020 16:58:00 +0100 Subject: [PATCH 30/58] well :) --- Makefile | 1 + 1 file changed, 1 insertion(+) diff --git a/Makefile b/Makefile index 88ff5c5..54a7402 100644 --- a/Makefile +++ b/Makefile @@ -13,6 +13,7 @@ exe: pyinstaller.exe -y edsm-getnearest.py pyinstaller.exe -y explorationtools.py +# probably won’t work unless you’re me :) release: clean rsync -avz gezocks:/mnt/d/git/elite-scripts/dist/ build/ cd build && zip -r ../$(zipfile) * -- 2.45.2 From bfad49905012e112d3f5e419c220f744f12909da Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Thu, 9 Jan 2020 21:37:42 +0100 Subject: [PATCH 31/58] added rounding option to `distancebetween` --- README.md | 8 +++++--- explorationtools.py | 11 ++++++++--- 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 2c560bb..be7b482 100644 --- a/README.md +++ b/README.md @@ -81,13 +81,15 @@ optional arguments: ``` ``` -usage: explorationtools.py distancebetween [-h] system system +usage: explorationtools.py distancebetween [-h] [--roundto [ROUNDTO]] + system system positional arguments: - system the systems to measure + system the systems to measure optional arguments: - -h, --help show this help message and exit + -h, --help show this help message and exit + --roundto [ROUNDTO] the number of digits to round to (default: 2) ``` ``` diff --git a/explorationtools.py b/explorationtools.py index 4a521c5..f412d17 100755 --- a/explorationtools.py +++ b/explorationtools.py @@ -12,9 +12,12 @@ from pyEDSM.edsm.models import System, Commander def getBodyCount(system): return System(system).bodyCount -def distanceBetween(system1, system2): +def distanceBetween(system1, system2, roundTo=2): systems = System.getSystems(system1, system2) - return systems[0].distanceTo(systems[1]) + distance = systems[0].distanceTo(systems[1], roundTo) + if roundTo == 0: + distance = int(distance) + return distance def getCommanderPosition(name, apikey): coords = Commander(name, apikey).currentPosition @@ -54,6 +57,8 @@ parser_distance = subparsers.add_parser("distancebetween", help="Calculates the distance between two systems. Will exit with code 1 " + "on server error and code 2 if (one of) the systems could not be found " + "on EDSM.") +parser_distance.add_argument("--roundto", nargs="?", type=int, default=2, + help="the number of digits to round to (default: 2)") parser_distance.add_argument("system", nargs=2, help="the systems to measure") parser_find = subparsers.add_parser("findcommander", @@ -84,7 +89,7 @@ try: if args.subCommand == "bodycount": out = getBodyCount(args.system[0]) elif args.subCommand == "distancebetween": - out = distanceBetween(args.system[0], args.system[1]) + out = distanceBetween(args.system[0], args.system[1], args.roundto) elif args.subCommand == "findcommander": if args.coords: out = getCommanderPosition(args.name, args.apikey) -- 2.45.2 From 37555b0a2e0eaa7bfee0770db6bedd5742009f85 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Mon, 13 Jan 2020 21:23:41 +0100 Subject: [PATCH 32/58] added `findsystem` command --- README.md | 17 +++++++++++++++-- explorationtools.py | 41 ++++++++++++++++++++++++++++++++++------- generate_docs.sh | 6 ++++++ 3 files changed, 55 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index be7b482..64fc9a7 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ optional arguments: ``` usage: explorationtools.py [-h] - {bodycount,distancebetween,findcommander,systemlist} + {bodycount,distancebetween,findcommander,findsystem,systemlist} ... A collection of tools useful for exploration. @@ -55,7 +55,7 @@ optional arguments: -h, --help show this help message and exit subcommands: - {bodycount,distancebetween,findcommander,systemlist} + {bodycount,distancebetween,findcommander,findsystem,systemlist} sub-command help bodycount Returns the number of bodies in a system. Will exit with code 1 on server error and code 2 if the system @@ -66,6 +66,9 @@ subcommands: findcommander Attempts to find a CMDR’s last known position. Will exit with code 1 on server error and code 2 if the CMDR could not be found on EDSM. + findsystem Attempts to find a partially matching system that + should then hopefully be in the vicinity of the given + system systemlist Pulls all system names starting with the given string from EDSM ``` @@ -108,6 +111,16 @@ optional arguments: --url output the commander’s profile URL ``` +``` +usage: explorationtools.py findsystem [-h] system + +positional arguments: + system the system in question + +optional arguments: + -h, --help show this help message and exit +``` + ``` usage: explorationtools.py systemlist [-h] partialsystem diff --git a/explorationtools.py b/explorationtools.py index f412d17..780cc32 100755 --- a/explorationtools.py +++ b/explorationtools.py @@ -33,14 +33,31 @@ def getCommanderSystem(name, apikey): return Commander(name, apikey).currentSystem def getSystemList(name): - ret = "" - systems = System.getSystems(name) + ret = "" for system in systems: ret += "{}\n".format(system.name) - return ret[:-1] +def getSystemNear(name): + # Probably want to abort at _some_ point. I’m defining two full words left as + # the condition for that now. + if name.count(' ') < 2: + ret = "Aborting search at {}, require more than 2 words to limit the " + ret += "result set." + return ret.format(name) + + try: + systems = System.getSystems(name) + except NotFoundError: + return getSystemNear(name[:-1]) + else: + ret = "" + for system in systems: + ret += "{} ({}, {}, {})\n".format(system.name, + system.coords['x'], system.coords['y'], system.coords['z']) + return ret[:-1] + # =========================================================================== parser = argparse.ArgumentParser(description="A collection of tools useful for " @@ -61,20 +78,25 @@ parser_distance.add_argument("--roundto", nargs="?", type=int, default=2, help="the number of digits to round to (default: 2)") parser_distance.add_argument("system", nargs=2, help="the systems to measure") -parser_find = subparsers.add_parser("findcommander", +parser_findCmdr = subparsers.add_parser("findcommander", help="Attempts to find a CMDR’s last known position. Will exit with code 1 " + "on server error and code 2 if the CMDR could not be found on EDSM.") -group = parser_find.add_mutually_exclusive_group(required=False) +group = parser_findCmdr.add_mutually_exclusive_group(required=False) group.add_argument('--system', action='store_true', help='output the commander’s last known system (default)') group.add_argument('--coords', action='store_true', help='output the commander’s last known position in {x,y,z} coordinates') group.add_argument('--url', action='store_true', help='output the commander’s profile URL') -parser_find.add_argument("name", help="the commander in question") -parser_find.add_argument("apikey", default="", nargs="?", +parser_findCmdr.add_argument("name", help="the commander in question") +parser_findCmdr.add_argument("apikey", default="", nargs="?", help="the commander’s EDSM API key. Can be empty for public profiles.") +parser_findSystem = subparsers.add_parser("findsystem", + help="Attempts to find a partially matching system that should then " + + "hopefully be in the vicinity of the given system") +parser_findSystem.add_argument("system", help="the system in question") + parser_bodycount = subparsers.add_parser("systemlist", help="Pulls all system names starting with the given string from EDSM") parser_bodycount.add_argument("partialsystem", nargs=1, @@ -97,8 +119,13 @@ try: out = getCommanderProfileUrl(args.name, args.apikey) else: out = getCommanderSystem(args.name, args.apikey) + elif args.subCommand == "findsystem": + out = getSystemNear(args.system) elif args.subCommand == "systemlist": out = getSystemList(args.partialsystem) + else: + parser.print_usage() + sys.exit(1) except ServerError as e: print(e) sys.exit(1) diff --git a/generate_docs.sh b/generate_docs.sh index 76e148c..a519a2e 100644 --- a/generate_docs.sh +++ b/generate_docs.sh @@ -58,6 +58,12 @@ EOF cat >> README.md << EOF \`\`\` +\`\`\` +EOF +./explorationtools.py findsystem -h >> README.md +cat >> README.md << EOF +\`\`\` + \`\`\` EOF ./explorationtools.py systemlist -h >> README.md -- 2.45.2 From 355b53c24ccc13a81ddbf23d6bc1d64476889988 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Mon, 13 Jan 2020 21:33:54 +0100 Subject: [PATCH 33/58] =?UTF-8?q?updated=20README=20with=20pyEDSM=E2=80=99?= =?UTF-8?q?s=20requirements?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit That will aaaaall go away once I decide to properly package that … --- README.md | 6 ++++-- generate_docs.sh | 6 ++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 64fc9a7..326f0be 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,10 @@ * Tkinter You probably want to install your distribution/OS package for Tkinter instead of -using pip. Then do the good old `pip install --user -r requirements.txt` or -`pip3 install --user -r requirements.txt`. +using pip. Then do the good old `pip install --user -r requirements.txt`. + +You’ll also need to install pyEDSM’s dependencies: +`pip install --user -r pyEDSM/requirements.txt` ## Pre-Compiled Version (Windows) ## diff --git a/generate_docs.sh b/generate_docs.sh index a519a2e..3bfb2c7 100644 --- a/generate_docs.sh +++ b/generate_docs.sh @@ -10,8 +10,10 @@ cat > README.md << EOF * Tkinter You probably want to install your distribution/OS package for Tkinter instead of -using pip. Then do the good old \`pip install --user -r requirements.txt\` or -\`pip3 install --user -r requirements.txt\`. +using pip. Then do the good old \`pip install --user -r requirements.txt\`. + +You’ll also need to install pyEDSM’s dependencies: +\`pip install --user -r pyEDSM/requirements.txt\` ## Pre-Compiled Version (Windows) ## -- 2.45.2 From b3810ac0c72a8778c00816454edce1c0132f0239 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Mon, 13 Jan 2020 22:23:48 +0100 Subject: [PATCH 34/58] updated to current pyEDSM --- pyEDSM | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyEDSM b/pyEDSM index b476c34..a2c9fb1 160000 --- a/pyEDSM +++ b/pyEDSM @@ -1 +1 @@ -Subproject commit b476c34de50e6a76f93a522140acbf3536f18728 +Subproject commit a2c9fb15400e760c86c3a47bd2e7d1c1e5adef61 -- 2.45.2 From 16a903ac221b9a02913934c65d337d7c87aa8b02 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Mon, 13 Jan 2020 22:25:58 +0100 Subject: [PATCH 35/58] updated Makefile MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit now I hopefully won’t forget to pull new dependencies before building the Windows binaries … --- Makefile | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Makefile b/Makefile index 54a7402..506c5e6 100644 --- a/Makefile +++ b/Makefile @@ -10,6 +10,8 @@ docs: # requires a windows box exe: + pip install --user -r requirements.txt + pip install --user -r pyEDSM\requirements.txt pyinstaller.exe -y edsm-getnearest.py pyinstaller.exe -y explorationtools.py -- 2.45.2 From c23e9ad58bc0eaf9f739f0f8bcf8b14eddf3176a Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Mon, 13 Jan 2020 22:54:18 +0100 Subject: [PATCH 36/58] updated to current pyEDSM --- pyEDSM | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyEDSM b/pyEDSM index a2c9fb1..82519b9 160000 --- a/pyEDSM +++ b/pyEDSM @@ -1 +1 @@ -Subproject commit a2c9fb15400e760c86c3a47bd2e7d1c1e5adef61 +Subproject commit 82519b9d668a2a3be2aea27126bc4cd44763132d -- 2.45.2 From fad3bd4adb649f453e48157ed8ecefd381ce8a33 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Wed, 15 Jan 2020 09:09:15 +0100 Subject: [PATCH 37/58] redirected usage text to stderr --- explorationtools.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/explorationtools.py b/explorationtools.py index 780cc32..c8e6ce7 100755 --- a/explorationtools.py +++ b/explorationtools.py @@ -124,7 +124,7 @@ try: elif args.subCommand == "systemlist": out = getSystemList(args.partialsystem) else: - parser.print_usage() + parser.print_usage(sys.stderr) sys.exit(1) except ServerError as e: print(e) -- 2.45.2 From ea0785a6396a7722ef6af63ac3f3e9c267ed66df Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Wed, 15 Jan 2020 09:19:36 +0100 Subject: [PATCH 38/58] =?UTF-8?q?=E2=80=A6=20or=20just=20do=20it=20right?= =?UTF-8?q?=20in=20the=20first=20place?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- explorationtools.py | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/explorationtools.py b/explorationtools.py index c8e6ce7..2d4d97d 100755 --- a/explorationtools.py +++ b/explorationtools.py @@ -63,7 +63,7 @@ def getSystemNear(name): parser = argparse.ArgumentParser(description="A collection of tools useful for " + "exploration.") subparsers = parser.add_subparsers(title="subcommands", help="sub-command help", - dest="subCommand") + dest="subcommand", required=True) parser_bodycount = subparsers.add_parser("bodycount", help="Returns the number of bodies in a system. Will exit with code 1 on " @@ -123,9 +123,6 @@ try: out = getSystemNear(args.system) elif args.subCommand == "systemlist": out = getSystemList(args.partialsystem) - else: - parser.print_usage(sys.stderr) - sys.exit(1) except ServerError as e: print(e) sys.exit(1) -- 2.45.2 From 6c4437db6ac91c49690073ff6bdfe09cfc01b725 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Wed, 15 Jan 2020 22:58:33 +0100 Subject: [PATCH 39/58] =?UTF-8?q?don=E2=80=99t=20we=20all=20like=20the=20l?= =?UTF-8?q?itte=20bugs=20you=20introduce=20on=20the=20side=3F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- explorationtools.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/explorationtools.py b/explorationtools.py index 2d4d97d..414394c 100755 --- a/explorationtools.py +++ b/explorationtools.py @@ -108,20 +108,20 @@ args = parser.parse_args() # =========================================================================== try: - if args.subCommand == "bodycount": + if args.subcommand == "bodycount": out = getBodyCount(args.system[0]) - elif args.subCommand == "distancebetween": + elif args.subcommand == "distancebetween": out = distanceBetween(args.system[0], args.system[1], args.roundto) - elif args.subCommand == "findcommander": + elif args.subcommand == "findcommander": if args.coords: out = getCommanderPosition(args.name, args.apikey) elif args.url: out = getCommanderProfileUrl(args.name, args.apikey) else: out = getCommanderSystem(args.name, args.apikey) - elif args.subCommand == "findsystem": + elif args.subcommand == "findsystem": out = getSystemNear(args.system) - elif args.subCommand == "systemlist": + elif args.subcommand == "systemlist": out = getSystemList(args.partialsystem) except ServerError as e: print(e) -- 2.45.2 From 13510f982496154201b64ebe5f2959edd2571898 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Thu, 16 Jan 2020 18:50:23 +0100 Subject: [PATCH 40/58] findcommander now gives a date for the known position --- README.md | 4 +++- explorationtools.py | 25 +++++++++++++++++++++++-- pyEDSM | 2 +- 3 files changed, 27 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 326f0be..0c7d767 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,9 @@ subcommands: systems could not be found on EDSM. findcommander Attempts to find a CMDR’s last known position. Will exit with code 1 on server error and code 2 if the - CMDR could not be found on EDSM. + CMDR could not be found on EDSM. Will also give you + the time of last activity if you search for their + system. findsystem Attempts to find a partially matching system that should then hopefully be in the vicinity of the given system diff --git a/explorationtools.py b/explorationtools.py index 414394c..8194297 100755 --- a/explorationtools.py +++ b/explorationtools.py @@ -3,6 +3,7 @@ import argcomplete, argparse import math import sys +from datetime import datetime from pyEDSM.edsm.exception import ServerError, NotFoundError from pyEDSM.edsm.models import System, Commander @@ -30,7 +31,26 @@ def getCommanderProfileUrl(name, apikey): return Commander(name, apikey).profileUrl def getCommanderSystem(name, apikey): - return Commander(name, apikey).currentSystem + cmdr = Commander(name, apikey) + return "{} (last seen {})".format(cmdr.currentSystem, + when(cmdr.lastActivity)) +def when(date): + diff = datetime.now() - date + ret = "" + if diff.days > 0: + ret += "{} days ".format(diff.days) + if diff.seconds > 0: + hours = int(diff.seconds / 3600) + if hours > 0: + ret += "{} hours ".format(hours) + minutes = int(diff.seconds % 3600 / 60) + if minutes > 0: + ret += "{} minutes ".format(minutes) + if diff.days == 0 and hours == 0 and minutes == 0: + # ONLY seconds! + ret = "{} seconds ".format(diff.seconds) + ret += "ago" + return ret def getSystemList(name): systems = System.getSystems(name) @@ -80,7 +100,8 @@ parser_distance.add_argument("system", nargs=2, help="the systems to measure") parser_findCmdr = subparsers.add_parser("findcommander", help="Attempts to find a CMDR’s last known position. Will exit with code 1 " - + "on server error and code 2 if the CMDR could not be found on EDSM.") + + "on server error and code 2 if the CMDR could not be found on EDSM. Will " + + "also give you the time of last activity if you search for their system.") group = parser_findCmdr.add_mutually_exclusive_group(required=False) group.add_argument('--system', action='store_true', help='output the commander’s last known system (default)') diff --git a/pyEDSM b/pyEDSM index 82519b9..dc18cbb 160000 --- a/pyEDSM +++ b/pyEDSM @@ -1 +1 @@ -Subproject commit 82519b9d668a2a3be2aea27126bc4cd44763132d +Subproject commit dc18cbb914dd5efeba14f4a2f0e2664219462c38 -- 2.45.2 From 8be1f175879b622052224100cd8c7da0b0defd85 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Thu, 16 Jan 2020 19:31:14 +0100 Subject: [PATCH 41/58] updated to latest pyEDSM --- pyEDSM | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyEDSM b/pyEDSM index dc18cbb..36a660f 160000 --- a/pyEDSM +++ b/pyEDSM @@ -1 +1 @@ -Subproject commit dc18cbb914dd5efeba14f4a2f0e2664219462c38 +Subproject commit 36a660f240c7e57cf524fe9640d13e56c7e42e79 -- 2.45.2 From 8567aeb767ed718877998a5c81858e509d14f1f2 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Fri, 17 Jan 2020 16:04:45 +0100 Subject: [PATCH 42/58] updated Makefile; now only a single .exe per script --- Makefile | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Makefile b/Makefile index 506c5e6..272ff67 100644 --- a/Makefile +++ b/Makefile @@ -10,10 +10,10 @@ docs: # requires a windows box exe: - pip install --user -r requirements.txt - pip install --user -r pyEDSM\requirements.txt - pyinstaller.exe -y edsm-getnearest.py - pyinstaller.exe -y explorationtools.py + pip install --user --upgrade -r requirements.txt + pip install --user --upgrade -r pyEDSM\requirements.txt + python -OO -m PyInstaller --clean -yF edsm-getnearest.py + python -OO -m PyInstaller --clean -yF explorationtools.py # probably won’t work unless you’re me :) release: clean -- 2.45.2 From 0f30584bf34388e86d8b792bef7b9c1e96ea4906 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Wed, 4 Mar 2020 18:06:00 +0100 Subject: [PATCH 43/58] =?UTF-8?q?added=20LICENSE;=20no=20idea=20why=20that?= =?UTF-8?q?=20wasn=E2=80=99t=20versioned=20=E2=80=A6?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- LICENSE | 674 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 674 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. -- 2.45.2 From 95f5de2377d19448edc40241f94a5d2e995b14a4 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Wed, 4 Mar 2020 18:07:56 +0100 Subject: [PATCH 44/58] added spansh.py for Spansh API related shenanigans --- Makefile | 1 + README.md | 29 ++++++++++++++++++++ generate_docs.sh | 14 ++++++++++ spansh.py | 71 ++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 115 insertions(+) create mode 100755 spansh.py diff --git a/Makefile b/Makefile index 272ff67..02ccf96 100644 --- a/Makefile +++ b/Makefile @@ -14,6 +14,7 @@ exe: pip install --user --upgrade -r pyEDSM\requirements.txt python -OO -m PyInstaller --clean -yF edsm-getnearest.py python -OO -m PyInstaller --clean -yF explorationtools.py + python -OO -m PyInstaller --clean -yF spansh.py # probably won’t work unless you’re me :) release: clean diff --git a/README.md b/README.md index 0c7d767..6f7c72f 100644 --- a/README.md +++ b/README.md @@ -135,6 +135,35 @@ optional arguments: -h, --help show this help message and exit ``` +### spansh.py ### + +``` +usage: spansh.py [-h] {oldstations} ... + +Script for interfacing with Spansh’s API. + +optional arguments: + -h, --help show this help message and exit + +subcommands: + {oldstations} sub-command help + oldstations Searches for stations with old data (>1 year without an + update. +``` + +``` +usage: spansh.py oldstations [-h] [--system [SYSTEM]] [--count [COUNT]] + [--systemlist] + +optional arguments: + -h, --help show this help message and exit + --system [SYSTEM] a single system to query. If not present, get the oldest + stations overall. + --count [COUNT] how many stations to output. Defaults to 50. + --systemlist outputs a list of systems to visit _only_, no station + names (for)easy system names c&p +``` + ## Need Help / Want to Contribute? ## Just [file an issue](https://github.com/alterNERDtive/elite-scripts/issues/new) diff --git a/generate_docs.sh b/generate_docs.sh index 3bfb2c7..b183f74 100644 --- a/generate_docs.sh +++ b/generate_docs.sh @@ -72,6 +72,20 @@ EOF cat >> README.md << EOF \`\`\` +### spansh.py ### + +\`\`\` +EOF +./spansh.py -h >> README.md +cat >> README.md << EOF +\`\`\` + +\`\`\` +EOF +./spansh.py oldstations -h >> README.md +cat >> README.md << EOF +\`\`\` + ## Need Help / Want to Contribute? ## Just [file an issue](https://github.com/alterNERDtive/elite-scripts/issues/new) diff --git a/spansh.py b/spansh.py new file mode 100755 index 0000000..fecfcaf --- /dev/null +++ b/spansh.py @@ -0,0 +1,71 @@ +#!/usr/bin/env python3 +# PYTHON_ARGCOMPLETE_OK +import argcomplete, argparse +import requests +import sys + +# =========================================================================== + +def getOldStations(count, systemsonly): + url = "http://backend3.spansh.co.uk:3000/api/stations/search" + params = {"json": '{"filters":{"updated_at":{"value":["2017-11-06","2019-03-01"],"comparison":"<=>"}},"sort":[{"updated_at":{"direction":"asc"}}],"size":' + str(count) + '}'} + + json = requests.post(url, params).json() + + ret ="" + + if systemsonly: + for station in json["results"]: + ret += "{}\n".format(station["system_name"]) + else: + for station in json["results"]: + ret += "{}: {} ({})\n".format(station["system_name"], station["name"], + station["updated_at"]) + + return ret[:-1] + +def getOldStationsInSystem(system): + url = "http://backend3.spansh.co.uk:3000/api/stations/search" + params = {"json": '{"filters": {"system_name": {"value": "' + system + '"},"updated_at":{"value":["2017-11-06","2019-03-01"],"comparison":"<=>"}},"sort":[{"updated_at":{"direction":"asc"}}]}'} + + json = requests.post(url, params).json() + + ret ="" + + for station in json["results"]: + ret += "{}, ".format(station["name"]) + + return ret[:-2] + +# =========================================================================== + +parser = argparse.ArgumentParser(description="Script for interfacing with " + + "Spansh’s API.") +subparsers = parser.add_subparsers(title="subcommands", help="sub-command help", + dest="subcommand", required=True) + +parser_oldstations = subparsers.add_parser("oldstations", + help="Searches for stations with old data (>1 year without an update.") +parser_oldstations.add_argument("--system", nargs="?", + help="a single system to query. If not present, get the oldest stations " + + "overall.") +parser_oldstations.add_argument("--count", nargs="?", type=int, default=50, + help="how many stations to output. Defaults to 50.") +parser_oldstations.add_argument("--systemlist", action='store_true', + help="outputs a list of systems to visit _only_, no station names (for)" + + "easy system names c&p") + +argcomplete.autocomplete(parser) +args = parser.parse_args() + +# =========================================================================== + +out ="" +if args.subcommand == "oldstations": + if args.system: + out = getOldStationsInSystem(args.system) + else: + out = getOldStations(args.count, args.systemlist) + +print(out) +sys.exit(0) -- 2.45.2 From cf3fb8023862e24988330e7538bbf6a0898d6d30 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Wed, 4 Mar 2020 20:42:57 +0100 Subject: [PATCH 45/58] spansh.py: now exits with (3) if nothing found --- spansh.py | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/spansh.py b/spansh.py index fecfcaf..61362d4 100755 --- a/spansh.py +++ b/spansh.py @@ -67,5 +67,8 @@ if args.subcommand == "oldstations": else: out = getOldStations(args.count, args.systemlist) -print(out) -sys.exit(0) +if out == "": + sys.exit(3) +else: + print(out) + sys.exit(0) -- 2.45.2 From 7ee4b28c593d9b59cf9c2a6b614a6982999b1c0b Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Thu, 5 Mar 2020 14:05:12 +0100 Subject: [PATCH 46/58] spansh.py: refactoring and cleanup MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit It’s now a bit less quick & dirty. Still has no error handling beyond “works” or “doesn’t work”. --- spansh.py | 35 +++++++++++++++++++++++------------ 1 file changed, 23 insertions(+), 12 deletions(-) diff --git a/spansh.py b/spansh.py index 61362d4..69f054e 100755 --- a/spansh.py +++ b/spansh.py @@ -1,19 +1,19 @@ #!/usr/bin/env python3 # PYTHON_ARGCOMPLETE_OK import argcomplete, argparse +import json as JSON import requests import sys +from datetime import datetime, timedelta + # =========================================================================== -def getOldStations(count, systemsonly): - url = "http://backend3.spansh.co.uk:3000/api/stations/search" - params = {"json": '{"filters":{"updated_at":{"value":["2017-11-06","2019-03-01"],"comparison":"<=>"}},"sort":[{"updated_at":{"direction":"asc"}}],"size":' + str(count) + '}'} - - json = requests.post(url, params).json() +def getOldStations(systemsonly): + params = {"json": JSON.dumps({"filters": FILTERS, "sort": SORT, "size": COUNT})} + json = requests.post(APIURL, params).json() ret ="" - if systemsonly: for station in json["results"]: ret += "{}\n".format(station["system_name"]) @@ -25,13 +25,11 @@ def getOldStations(count, systemsonly): return ret[:-1] def getOldStationsInSystem(system): - url = "http://backend3.spansh.co.uk:3000/api/stations/search" - params = {"json": '{"filters": {"system_name": {"value": "' + system + '"},"updated_at":{"value":["2017-11-06","2019-03-01"],"comparison":"<=>"}},"sort":[{"updated_at":{"direction":"asc"}}]}'} - - json = requests.post(url, params).json() + FILTERS.update(system_name={"value": system}) + params = {"json": JSON.dumps({"filters": FILTERS, "sort": SORT})} + json = requests.post(APIURL, params).json() ret ="" - for station in json["results"]: ret += "{}, ".format(station["name"]) @@ -60,12 +58,25 @@ args = parser.parse_args() # =========================================================================== +APIURL = "http://backend3.spansh.co.uk:3000/api/stations/search" + +FILTERS = {"updated_at": + {"value": + ["2017-11-06", + (datetime.now() - timedelta(days=365)).strftime("%Y-%m-%d")], + "comparison": "<=>"}} +SORT = {"updated_at": {"direction": "asc"}} +COUNT = args.count + out ="" if args.subcommand == "oldstations": if args.system: out = getOldStationsInSystem(args.system) else: - out = getOldStations(args.count, args.systemlist) + out = getOldStations(args.systemlist) +else: + parser.print_usage(sys.stderr) + sys.exit(1) if out == "": sys.exit(3) -- 2.45.2 From adec36ded90892bcae156b9ccb2565bba4ad2681 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Thu, 5 Mar 2020 14:46:29 +0100 Subject: [PATCH 47/58] fixed docs typo --- README.md | 2 +- spansh.py | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6f7c72f..9ef17f7 100644 --- a/README.md +++ b/README.md @@ -161,7 +161,7 @@ optional arguments: stations overall. --count [COUNT] how many stations to output. Defaults to 50. --systemlist outputs a list of systems to visit _only_, no station - names (for)easy system names c&p + names (foreasy system names c&p) ``` ## Need Help / Want to Contribute? ## diff --git a/spansh.py b/spansh.py index 69f054e..b7e91eb 100755 --- a/spansh.py +++ b/spansh.py @@ -50,8 +50,8 @@ parser_oldstations.add_argument("--system", nargs="?", parser_oldstations.add_argument("--count", nargs="?", type=int, default=50, help="how many stations to output. Defaults to 50.") parser_oldstations.add_argument("--systemlist", action='store_true', - help="outputs a list of systems to visit _only_, no station names (for)" - + "easy system names c&p") + help="outputs a list of systems to visit _only_, no station names (for" + + "easy system names c&p)") argcomplete.autocomplete(parser) args = parser.parse_args() -- 2.45.2 From 19e8cbfdffdb932879faee01b8b7d851eff08eb9 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Sun, 8 Mar 2020 00:59:55 +0100 Subject: [PATCH 48/58] spansh.py: added short output format To both station and systems list. Replaces the `--systemlist` switch. --- README.md | 5 ++--- spansh.py | 23 ++++++++++++----------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 9ef17f7..bd7950d 100644 --- a/README.md +++ b/README.md @@ -153,15 +153,14 @@ subcommands: ``` usage: spansh.py oldstations [-h] [--system [SYSTEM]] [--count [COUNT]] - [--systemlist] + [--short] optional arguments: -h, --help show this help message and exit --system [SYSTEM] a single system to query. If not present, get the oldest stations overall. --count [COUNT] how many stations to output. Defaults to 50. - --systemlist outputs a list of systems to visit _only_, no station - names (foreasy system names c&p) + --short short output format (system/station names only) ``` ## Need Help / Want to Contribute? ## diff --git a/spansh.py b/spansh.py index b7e91eb..4c6c798 100755 --- a/spansh.py +++ b/spansh.py @@ -9,16 +9,15 @@ from datetime import datetime, timedelta # =========================================================================== -def getOldStations(systemsonly): +def getOldStations(): params = {"json": JSON.dumps({"filters": FILTERS, "sort": SORT, "size": COUNT})} json = requests.post(APIURL, params).json() ret ="" - if systemsonly: - for station in json["results"]: + for station in json["results"]: + if args.short: ret += "{}\n".format(station["system_name"]) - else: - for station in json["results"]: + else: ret += "{}: {} ({})\n".format(station["system_name"], station["name"], station["updated_at"]) @@ -31,9 +30,12 @@ def getOldStationsInSystem(system): ret ="" for station in json["results"]: - ret += "{}, ".format(station["name"]) + if args.short: + ret += "{}\n".format(station["name"]) + else: + ret += "{} ({})\n".format(station["name"], station["updated_at"]) - return ret[:-2] + return ret[:-1] # =========================================================================== @@ -49,9 +51,8 @@ parser_oldstations.add_argument("--system", nargs="?", + "overall.") parser_oldstations.add_argument("--count", nargs="?", type=int, default=50, help="how many stations to output. Defaults to 50.") -parser_oldstations.add_argument("--systemlist", action='store_true', - help="outputs a list of systems to visit _only_, no station names (for" - + "easy system names c&p)") +parser_oldstations.add_argument("--short", action='store_true', + help="short output format (system/station names only)") argcomplete.autocomplete(parser) args = parser.parse_args() @@ -73,7 +74,7 @@ if args.subcommand == "oldstations": if args.system: out = getOldStationsInSystem(args.system) else: - out = getOldStations(args.systemlist) + out = getOldStations() else: parser.print_usage(sys.stderr) sys.exit(1) -- 2.45.2 From 07ca9ec406ed86c7a6521e36b7d2eadd64c72fce Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Mon, 9 Mar 2020 17:39:44 +0100 Subject: [PATCH 49/58] spansh.py: added `nearestsystem` subcommand MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Used to get the nearest system in the database, e.g. for plotting a neutron route. Useful since the elastic search powering the plotter might be behind current EDDN data, so having a system in EDDN/EDSM doesn’t necessarily mean it’s already available in the router. --- README.md | 24 +++++++++++---- generate_docs.sh | 6 ++++ spansh.py | 78 ++++++++++++++++++++++++++++++++++++++---------- 3 files changed, 88 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index bd7950d..40f2382 100644 --- a/README.md +++ b/README.md @@ -138,17 +138,31 @@ optional arguments: ### spansh.py ### ``` -usage: spansh.py [-h] {oldstations} ... +usage: spansh.py [-h] {nearestsystem,oldstations} ... Script for interfacing with Spansh’s API. optional arguments: - -h, --help show this help message and exit + -h, --help show this help message and exit subcommands: - {oldstations} sub-command help - oldstations Searches for stations with old data (>1 year without an - update. + {nearestsystem,oldstations} + sub-command help + nearestsystem Searches for the nearest system in the database to + given coordinates. + oldstations Searches for stations with old data (>1 year without + an update. +``` + +``` +usage: spansh.py nearestsystem [-h] [--short] coordinate coordinate coordinate + +positional arguments: + coordinate the coordinates to search for (order: x, y, z) + +optional arguments: + -h, --help show this help message and exit + --short short output format (system name only) ``` ``` diff --git a/generate_docs.sh b/generate_docs.sh index b183f74..cb9a73f 100644 --- a/generate_docs.sh +++ b/generate_docs.sh @@ -80,6 +80,12 @@ EOF cat >> README.md << EOF \`\`\` +\`\`\` +EOF +./spansh.py nearestsystem -h >> README.md +cat >> README.md << EOF +\`\`\` + \`\`\` EOF ./spansh.py oldstations -h >> README.md diff --git a/spansh.py b/spansh.py index 4c6c798..d7381c8 100755 --- a/spansh.py +++ b/spansh.py @@ -9,9 +9,33 @@ from datetime import datetime, timedelta # =========================================================================== +def getNearestSystem(coords): + params = { + "x": coords[0], + "y": coords[1], + "z": coords[2] + } + json = requests.post(APIURLS["nearest"], params).json() + + ret = "" + if args.short: + ret = json["system"]["name"] + else: + system = json["system"] + ret = "{} ({}, {}, {}), {} ly".format(system["name"], system["x"], + system["y"], system["z"], round(system["distance"], 2)) + + return ret + def getOldStations(): - params = {"json": JSON.dumps({"filters": FILTERS, "sort": SORT, "size": COUNT})} - json = requests.post(APIURL, params).json() + params = { + "json": JSON.dumps({ + "filters": FILTERS, + "sort": SORT, + "size": args.count + }) + } + json = requests.post(APIURLS["stations"], params).json() ret ="" for station in json["results"]: @@ -25,8 +49,13 @@ def getOldStations(): def getOldStationsInSystem(system): FILTERS.update(system_name={"value": system}) - params = {"json": JSON.dumps({"filters": FILTERS, "sort": SORT})} - json = requests.post(APIURL, params).json() + params = { + "json": JSON.dumps({ + "filters": FILTERS, + "sort": SORT + }) + } + json = requests.post(APIURLS["stations"], params).json() ret ="" for station in json["results"]: @@ -44,11 +73,18 @@ parser = argparse.ArgumentParser(description="Script for interfacing with " subparsers = parser.add_subparsers(title="subcommands", help="sub-command help", dest="subcommand", required=True) +parser_nearestsystem = subparsers.add_parser("nearestsystem", + help="Searches for the nearest system in the database to given coordinates.") +parser_nearestsystem.add_argument("coordinate", nargs=3, type=int, + help="the coordinates to search for (order: x, y, z)") +parser_nearestsystem.add_argument("--short", action='store_true', + help="short output format (system name only)") + parser_oldstations = subparsers.add_parser("oldstations", help="Searches for stations with old data (>1 year without an update.") parser_oldstations.add_argument("--system", nargs="?", help="a single system to query. If not present, get the oldest stations " - + "overall.") + + "overall.") parser_oldstations.add_argument("--count", nargs="?", type=int, default=50, help="how many stations to output. Defaults to 50.") parser_oldstations.add_argument("--short", action='store_true', @@ -59,18 +95,30 @@ args = parser.parse_args() # =========================================================================== -APIURL = "http://backend3.spansh.co.uk:3000/api/stations/search" - -FILTERS = {"updated_at": - {"value": - ["2017-11-06", - (datetime.now() - timedelta(days=365)).strftime("%Y-%m-%d")], - "comparison": "<=>"}} -SORT = {"updated_at": {"direction": "asc"}} -COUNT = args.count +APIURLS = { + "stations": "https://spansh.co.uk/api/stations/search", + "nearest": "https://spansh.co.uk/api/nearest" + } +FILTERS = { + "updated_at": + { + "value": [ + "2017-11-06", + (datetime.now() - timedelta(days=365)).strftime("%Y-%m-%d") + ], + "comparison": "<=>" + } + } +SORT = { + "updated_at": { + "direction": "asc" + } + } out ="" -if args.subcommand == "oldstations": +if args.subcommand == "nearestsystem": + out = getNearestSystem(args.coordinate) +elif args.subcommand == "oldstations": if args.system: out = getOldStationsInSystem(args.system) else: -- 2.45.2 From 15a8deca6574674b7a3e10d88bc815dc7b7e3a28 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Mon, 9 Mar 2020 17:51:36 +0100 Subject: [PATCH 50/58] spansh.py: added `--parsable` format to `nearestsystem` --- README.md | 4 +++- spansh.py | 13 ++++++++++--- 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 40f2382..cf10c30 100644 --- a/README.md +++ b/README.md @@ -155,7 +155,8 @@ subcommands: ``` ``` -usage: spansh.py nearestsystem [-h] [--short] coordinate coordinate coordinate +usage: spansh.py nearestsystem [-h] [--short | --parsable] + coordinate coordinate coordinate positional arguments: coordinate the coordinates to search for (order: x, y, z) @@ -163,6 +164,7 @@ positional arguments: optional arguments: -h, --help show this help message and exit --short short output format (system name only) + --parsable parsable output format (|,,|) ``` ``` diff --git a/spansh.py b/spansh.py index d7381c8..e89d4e8 100755 --- a/spansh.py +++ b/spansh.py @@ -17,9 +17,13 @@ def getNearestSystem(coords): } json = requests.post(APIURLS["nearest"], params).json() - ret = "" + ret = None + system = json["system"] if args.short: - ret = json["system"]["name"] + ret = system["name"] + elif args.parsable: + ret = "{}|{},{},{}|{}".format(system["name"], system["x"], + system["y"], system["z"], round(system["distance"], 2)) else: system = json["system"] ret = "{} ({}, {}, {}), {} ly".format(system["name"], system["x"], @@ -77,8 +81,11 @@ parser_nearestsystem = subparsers.add_parser("nearestsystem", help="Searches for the nearest system in the database to given coordinates.") parser_nearestsystem.add_argument("coordinate", nargs=3, type=int, help="the coordinates to search for (order: x, y, z)") -parser_nearestsystem.add_argument("--short", action='store_true', +group = parser_nearestsystem.add_mutually_exclusive_group(required=False) +group.add_argument("--short", action='store_true', help="short output format (system name only)") +group.add_argument("--parsable", action='store_true', + help="parsable output format (|,,|)") parser_oldstations = subparsers.add_parser("oldstations", help="Searches for stations with old data (>1 year without an update.") -- 2.45.2 From 07a6db2595a90a1eb664e9005766987b75d2738f Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Mon, 9 Mar 2020 17:59:35 +0100 Subject: [PATCH 51/58] spansh.py: misc fixes --- spansh.py | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/spansh.py b/spansh.py index e89d4e8..074ac1d 100755 --- a/spansh.py +++ b/spansh.py @@ -41,7 +41,7 @@ def getOldStations(): } json = requests.post(APIURLS["stations"], params).json() - ret ="" + ret = "" for station in json["results"]: if args.short: ret += "{}\n".format(station["system_name"]) @@ -61,7 +61,7 @@ def getOldStationsInSystem(system): } json = requests.post(APIURLS["stations"], params).json() - ret ="" + ret = "" for station in json["results"]: if args.short: ret += "{}\n".format(station["name"]) @@ -122,7 +122,7 @@ SORT = { } } -out ="" +out = None if args.subcommand == "nearestsystem": out = getNearestSystem(args.coordinate) elif args.subcommand == "oldstations": @@ -130,12 +130,6 @@ elif args.subcommand == "oldstations": out = getOldStationsInSystem(args.system) else: out = getOldStations() -else: - parser.print_usage(sys.stderr) - sys.exit(1) -if out == "": - sys.exit(3) -else: - print(out) - sys.exit(0) +print(out) +sys.exit(0) -- 2.45.2 From 0054b5ae6cc7b3e5f8544ee03fa450eb1955bdb5 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Mon, 9 Mar 2020 18:12:26 +0100 Subject: [PATCH 52/58] spansh.py: rudimentary error handling --- spansh.py | 52 ++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 38 insertions(+), 14 deletions(-) diff --git a/spansh.py b/spansh.py index 074ac1d..c83b3a5 100755 --- a/spansh.py +++ b/spansh.py @@ -7,6 +7,20 @@ import sys from datetime import datetime, timedelta +from pyEDSM.edsm.exception import ServerError, NotFoundError + +# =========================================================================== + +def querystations(url, params): + response = requests.post(url, params) + if response.status_code != 200: + raise ServerError(url, params) + json = response.json() + if json["count"] == 0: + raise NotFoundError() + print(json) + return json + # =========================================================================== def getNearestSystem(coords): @@ -15,7 +29,11 @@ def getNearestSystem(coords): "y": coords[1], "z": coords[2] } - json = requests.post(APIURLS["nearest"], params).json() + response = requests.post(APIURLS["nearest"], params) + if response.status_code != 200: + raise ServerError(url, params) + + json = response.json() ret = None system = json["system"] @@ -39,7 +57,7 @@ def getOldStations(): "size": args.count }) } - json = requests.post(APIURLS["stations"], params).json() + json = querystations(APIURLS["stations"], params) ret = "" for station in json["results"]: @@ -59,7 +77,7 @@ def getOldStationsInSystem(system): "sort": SORT }) } - json = requests.post(APIURLS["stations"], params).json() + json = querystations(APIURLS["stations"], params) ret = "" for station in json["results"]: @@ -122,14 +140,20 @@ SORT = { } } -out = None -if args.subcommand == "nearestsystem": - out = getNearestSystem(args.coordinate) -elif args.subcommand == "oldstations": - if args.system: - out = getOldStationsInSystem(args.system) - else: - out = getOldStations() - -print(out) -sys.exit(0) +try: + if args.subcommand == "nearestsystem": + out = getNearestSystem(args.coordinate) + elif args.subcommand == "oldstations": + if args.system: + out = getOldStationsInSystem(args.system) + else: + out = getOldStations() +except ServerError as e: + print(e) + sys.exit(1) +except NotFoundError as e: + print("No results found.") + sys.exit(2) +else: + print(out) + sys.exit(0) -- 2.45.2 From 5704593f4f9e56991855928b0b36dbc31ca3d606 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Mon, 9 Mar 2020 18:15:25 +0100 Subject: [PATCH 53/58] =?UTF-8?q?spansh.py:=20fixed=20=E2=80=9Cnothing=20f?= =?UTF-8?q?ound=E2=80=9D=20exit=20code?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- spansh.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spansh.py b/spansh.py index c83b3a5..59a5850 100755 --- a/spansh.py +++ b/spansh.py @@ -153,7 +153,7 @@ except ServerError as e: sys.exit(1) except NotFoundError as e: print("No results found.") - sys.exit(2) + sys.exit(3) else: print(out) sys.exit(0) -- 2.45.2 From fec66bfebb8ab4a3de1d35efb84f98d8b247bba0 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Mon, 9 Mar 2020 19:53:49 +0100 Subject: [PATCH 54/58] spansh.py: added `systemexists` subcommand --- README.md | 16 ++++++++++++++-- generate_docs.sh | 6 ++++++ spansh.py | 35 ++++++++++++++++++++++++++++++++++- 3 files changed, 54 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index cf10c30..c68716e 100644 --- a/README.md +++ b/README.md @@ -138,7 +138,7 @@ optional arguments: ### spansh.py ### ``` -usage: spansh.py [-h] {nearestsystem,oldstations} ... +usage: spansh.py [-h] {nearestsystem,oldstations,systemexists} ... Script for interfacing with Spansh’s API. @@ -146,12 +146,14 @@ optional arguments: -h, --help show this help message and exit subcommands: - {nearestsystem,oldstations} + {nearestsystem,oldstations,systemexists} sub-command help nearestsystem Searches for the nearest system in the database to given coordinates. oldstations Searches for stations with old data (>1 year without an update. + systemexists Checks if a given system exists in the search + database. ``` ``` @@ -179,6 +181,16 @@ optional arguments: --short short output format (system/station names only) ``` +``` +usage: spansh.py systemexists [-h] system + +positional arguments: + system the system to search for + +optional arguments: + -h, --help show this help message and exit +``` + ## Need Help / Want to Contribute? ## Just [file an issue](https://github.com/alterNERDtive/elite-scripts/issues/new) diff --git a/generate_docs.sh b/generate_docs.sh index cb9a73f..c790f2b 100644 --- a/generate_docs.sh +++ b/generate_docs.sh @@ -92,6 +92,12 @@ EOF cat >> README.md << EOF \`\`\` +\`\`\` +EOF +./spansh.py systemexists -h >> README.md +cat >> README.md << EOF +\`\`\` + ## Need Help / Want to Contribute? ## Just [file an issue](https://github.com/alterNERDtive/elite-scripts/issues/new) diff --git a/spansh.py b/spansh.py index 59a5850..4d697d8 100755 --- a/spansh.py +++ b/spansh.py @@ -88,6 +88,31 @@ def getOldStationsInSystem(system): return ret[:-1] +def systemExists(system): + params = { + "json": JSON.dumps({ + "filters": { + "name": { + "value": system + } + } + }) + } + response = requests.post(APIURLS["systems"], params) + if response.status_code != 200: + raise ServerError(url, params) + + json = response.json() + if json["count"] == 0: + raise NotFoundError() + + ret = "" + for system in json["results"]: + ret += "{} ({}, {}, {})\n".format(system["name"], system["x"], system["y"], + system["z"]) + + return ret[:-1] + # =========================================================================== parser = argparse.ArgumentParser(description="Script for interfacing with " @@ -115,14 +140,20 @@ parser_oldstations.add_argument("--count", nargs="?", type=int, default=50, parser_oldstations.add_argument("--short", action='store_true', help="short output format (system/station names only)") +parser_systemexists = subparsers.add_parser("systemexists", + help="Checks if a given system exists in the search database.") +parser_systemexists.add_argument("system", nargs=1, + help="the system to search for") + argcomplete.autocomplete(parser) args = parser.parse_args() # =========================================================================== APIURLS = { + "nearest": "https://spansh.co.uk/api/nearest", "stations": "https://spansh.co.uk/api/stations/search", - "nearest": "https://spansh.co.uk/api/nearest" + "systems": "https://spansh.co.uk/api/systems/search", } FILTERS = { "updated_at": @@ -148,6 +179,8 @@ try: out = getOldStationsInSystem(args.system) else: out = getOldStations() + elif args.subcommand == "systemexists": + out = systemExists(args.system) except ServerError as e: print(e) sys.exit(1) -- 2.45.2 From c9f6ef1bc0670ea038dc46613aa7bf14cc7a08e1 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Mon, 9 Mar 2020 22:08:33 +0100 Subject: [PATCH 55/58] added CHANGELOG --- CHANGELOG.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..51630d4 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,25 @@ +# 0.4 (2020-03-09) + +Kind of a big one. Obviously because in addition to EDSM, I can now do some +stuff with Spansh’s database. At this point I’m not sure if I want to keep it in +the kind of hacky quick&dirty state it’s in right now or do another abstraction +layer in addition to EDSM’s. Probably will be too lazy. + +In addition to that the compiled version of the scripts for windows will now be +a single executable file per script instead of having all the libraries stuff in +subfolders. It’s cleaner that way, IMO. + +## explorationtools.py + +* `findcommander` now gives a last seen date for the position + +known bugs: + +* I need to fix the way the commander’s last seen is pulled. Right now searching + for a commander will error out if their profile is public, but their flight + logs (and thus the last updated time stamp) is not. + +## spansh.py + +* added `spansh.py` for accessing data from https://spansh.co.uk +* see the README for what it can do right now -- 2.45.2 From 4a639f5a0e5f618d709a964ce1245e4eaaa8bf9a Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Fri, 24 Apr 2020 10:22:28 +0200 Subject: [PATCH 56/58] README: fixed Discord invite --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c68716e..9886c11 100644 --- a/README.md +++ b/README.md @@ -194,4 +194,4 @@ optional arguments: ## Need Help / Want to Contribute? ## Just [file an issue](https://github.com/alterNERDtive/elite-scripts/issues/new) -here or [hop into Discord](https://discord.gg/uUKFdW) if that is your thing. +here or [hop into Discord](https://discord.gg/XHNX7jN) if that is your thing. -- 2.45.2 From 3d4e25866ae4aa47ecf3c5208f8d82faefbe1796 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Fri, 24 Apr 2020 10:22:28 +0200 Subject: [PATCH 57/58] README: fixed Discord invite --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c68716e..9886c11 100644 --- a/README.md +++ b/README.md @@ -194,4 +194,4 @@ optional arguments: ## Need Help / Want to Contribute? ## Just [file an issue](https://github.com/alterNERDtive/elite-scripts/issues/new) -here or [hop into Discord](https://discord.gg/uUKFdW) if that is your thing. +here or [hop into Discord](https://discord.gg/XHNX7jN) if that is your thing. -- 2.45.2 From efa20d3801d98b6b88b6c230f199d780722b7017 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Mon, 4 May 2020 20:24:59 +0200 Subject: [PATCH 58/58] =?UTF-8?q?spansh.py:=20removed=20leftover=20debug?= =?UTF-8?q?=20`print`=20=E2=80=A6?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- spansh.py | 1 - 1 file changed, 1 deletion(-) diff --git a/spansh.py b/spansh.py index 4d697d8..69a467b 100755 --- a/spansh.py +++ b/spansh.py @@ -18,7 +18,6 @@ def querystations(url, params): json = response.json() if json["count"] == 0: raise NotFoundError() - print(json) return json # =========================================================================== -- 2.45.2