v0.1 commit

Author: Jan-Paul

LICENSE.txt

@@ -0,0 +1,23 @@
+MIT License
+
+Copyright (c) 2018 - White Russsian (https://github.com/WhiteRusssian)
+
+All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,81 @@
+<!--- // cSpell:words killboard, blops, hics, killboard's, cynos, ccp's, pyspy, psf's, pyperclip, pyinstaller, executables, jojo, unported --->
+
+# PySpy - A simple EVE Online character intel tool using CCP's ESI API
+
+## Background
+
+PySpy was born out of frustration over the *death* of [Pirate's Little Helper](http://eve-plh.com/#/home),
+a great [EVE Online](https://www.eveonline.com/) third-party tool for gathering useful information on character names from the in-game *local chat* window.
+
+PySpy connects to [CCP's ESI API](https://esi.evetech.net/ui/) and the
+[zKillboard API](https://github.com/zKillboard/zKillboard/wiki) and is available on Windows and macOS.
+
+## How to use PySpy
+
+1. Open PySpy.
+2. In your EVE client, select a list of characters and copy them to the clipboard (`CTRL+C` on Windows *or* `⌘+C` on macOS).
+3. Wait until PySpy is done and inspect the results.
+4. Double-click a name to open the respective zKillboard in your browser.
+
+**Note**: PySpy will save its window location, size, column sizes and transparency (slider on bottom right) settings automatically and restore them the next time you launch it. PySpy will stay on top of the EVE client so long as the game runs in *window mode*.
+
+## Information Provided by PySpy
+
+<p align="center">
+  <img alt="PySpy in action" src="https://github.com/WhiteRusssian/PySpy/blob/master/assets/v0.1_screenshot.png?raw=true">
+</p>
+
+* **Character**: Character name.
+* **Corporation**: Corporation of character.
+* **Alliance**: Alliance of Character's Corporation, if any.
+* **K**: Total number of kills.
+* **B**: Number of Black Ops Battleships (BLOPS) killed.
+* **H**: Number of lost Heavy Interdiction Cruisers (HIC).
+
+**Note**: Characters that have killed BLOPS or have lost HICs are high-lighted *orange*.
+
+**Current Limitations**: To avoid undue strain on zKillboard's API, PySpy will run the *K-B-H* analysis only for the first 20 characters in the list.
+
+## Installation
+
+You can download the latest release for your operating system [here](https://github.com/WhiteRusssian/PySpy/tree/master/download).
+
+PySpy comes as a single-file executable both in Windows and macOS. On both platforms, you can run PySpy from any folder location you like.
+
+**Note**: PySpy automatically checks for updates on launch.
+
+## Uninstalling PySpy
+
+Delete the PySpy executable and remove the following files manually:
+
+* **Windows**: PySpy saves preference and log files in a folder called  `PySpy` located at `%LocalAppData%`.
+* **macOS**: PySpy creates `pyspy.log` under `~/Library/Logs` and `pyspy.cfg` under `~/Library/Preferences`.
+
+## Future Features
+
+Below is a non-exhaustive list of additional features I plan to add to PySpy as and when the ESI and zKillboard APIs support them:
+
+* **Standings**: Only show characters that are non-blue, i.e. neutral or hostile.
+* **Cynos**: Indicate if a character has in the past lost ships fitted with regular or covert cynos.
+* **Improved GUI**: The current GUI is very basic and while it works, I do appreciate that it is not ideal for people who cannot use it on a second screen but actually have to overlay it on-top of their EVE client.
+
+## Bug Reporting
+
+Despite PySpy's simplicity and extensive testing, you may encounter the odd bug. If so, please check if an existing [issue](https://github.com/WhiteRusssian/PySpy/issues) already describes your bug. If not, feel free to [create a new issue](https://github.com/WhiteRusssian/PySpy/issues/new?template=bug_report.md) for your bug.
+
+## Dependencies & Acknowledgements
+
+* PySpy is written in [Python 3](https://www.python.org/) (v3.6.5), licensed under [PSF's License Agreement](https://docs.python.org/3/license.html#psf-license-agreement-for-python-release).
+* For API connectivity, PySpy relies on [Requests](http://docs.python-requests.org/) (v2.19.1), licensed under the [Apache License, Version 2.0](http://docs.python-requests.org/en/master/user/intro/#requests-license).
+* Clipboard monitoring is implemented with the help of [pyperclip](https://github.com/asweigart/pyperclip) (v1.6.2), licensed under the [3-Clause BSD License](https://github.com/asweigart/pyperclip/blob/master/LICENSE.txt).
+* The GUI is powered by [wxPython](https://www.wxpython.org/) (v4.0.3), licensed under the [wxWindows Library Licence](https://wxpython.org/pages/license/index.html).
+* The Windows and macOS executables are built using [pyinstaller](https://www.pyinstaller.org/), licensed under [its own modified GPL license](https://raw.githubusercontent.com/pyinstaller/pyinstaller/develop/COPYING.txt).
+* PySpy's icon was created by Jojo Mendoza and is licensed under [Creative Commons (Attribution-Noncommercial 3.0 Unported)](https://creativecommons.org/licenses/by-nc/3.0/). It is available on https://www.iconfinder.com/icons/1218719/cyber_hat_spy_undercover_user_icon.
+
+## License
+
+PySpy is licensed under the [MIT](LICENSE.txt) License.
+
+## CCP Copyright Notice
+
+EVE Online and the EVE logo are the registered trademarks of CCP hf. All rights are reserved worldwide. All other trademarks are the property of their respective owners. EVE Online, the EVE logo, EVE and all associated logos and designs are the intellectual property of CCP hf. All artwork, screenshots, characters, vehicles, storylines, world facts or other recognizable features of the intellectual property relating to these trademarks are likewise the intellectual property of CCP hf. CCP is in no way responsible for the content on or functioning of this website, nor can it be liable for any damage arising from the use of this website.

VERSION

@@ -0,0 +1 @@
+0.1

__main__.py

@@ -0,0 +1,91 @@
+# !/usr/local/bin/python3.6
+# MIT licensed
+# Copyright (c) 2018 White Russsian
+# Github: <https://github.com/WhiteRusssian/PySpy>**********************
+''' This is the primary module responsible for launching a background
+thread that watches for changes in the clipboard and if it detects a
+list of strings that could be EVE Online character strings, sends them
+to the analyze.py module to gather specific information from CCP's ESI
+API and zKIllboard's API. This information then gets sent to the GUI for
+output.
+'''
+# **********************************************************************
+import logging
+import re
+import threading
+import time
+
+import wx
+import pyperclip
+
+import analyze
+import chkversion
+import config
+import gui
+import statusmsg
+# cSpell Checker - Correct Words****************************************
+# // cSpell:words russsian, ccp's, pyperclip, chkversion, clpbd, gui
+# **********************************************************************
+Logger = logging.getLogger(__name__)
+# Example call: Logger.info("Something badhappened", exc_info=True) ****
+
+
+def watch_clpbd():
+    recent_value = None
+    while True:
+        clipboard = pyperclip.paste()
+        if clipboard != recent_value:
+            char_names = clipboard.splitlines()
+            for name in char_names:
+                valid = check_name_validity(name)
+                if valid is False:
+                    break
+            if valid:
+                statusmsg.push_status("Clipboard change detected...")
+                recent_value = clipboard
+                analyze_chars(clipboard.splitlines())
+        time.sleep(0.5)  # Short sleep between loops to reduce CPU load
+
+
+def check_name_validity(char_name):
+    if len(char_name) < 3:
+        return False
+    regex = r"[^ 'a-zA-Z0-9-]"  # Valid EVE Online character names
+    if re.search(regex, char_name):
+        return False
+    return True
+
+
+def analyze_chars(char_names):
+    start_time = time.time()
+    wx.CallAfter(app.PySpy.list.DeleteAllItems)
+    try:
+        outlist = analyze.main(char_names)
+        if outlist is not None:
+            wx.CallAfter(app.PySpy.update_list, outlist, start_time)
+        else:
+            statusmsg.push_status(
+                  "No valid character names found. Please try again..."
+                )
+    except Exception:
+        Logger.error(
+            "Failed to collect character information. Clipboard "
+            "content was: " + str(char_names), exc_info=True
+        )
+
+
+app = gui.App(0)  # Has to be defined before background thread starts.
+
+background_thread = threading.Thread(
+    target=watch_clpbd,
+    daemon=True
+)
+background_thread.start()
+
+update_checker = threading.Thread(
+    target=chkversion.chk_github_update,
+    daemon=True
+)
+update_checker.start()
+
+app.MainLoop()

__main__.spec

@@ -0,0 +1,68 @@
+# -*- mode: python -*-
+'''Cross-platform (MacOSX and Windows 10) Spec file for pyinstaller.
+Be sure to not use python 3.7 until pyinstaller supports it.'''
+# cSpell Checker - Correct Words****************************************
+# // cSpell:words pyinstaller, pyspy, posix, icns, getcwd, datas,
+# // cSpell:words tkinter, noconsole
+# **********************************************************************
+import os
+
+if os.name == "nt":
+    ICON_FILE = os.path.join("assets", "pyspy.ico")
+elif os.name == "posix":
+    ICON_FILE = os.path.join("assets", "pyspy.png")
+
+MAC_ICON = os.path.join("assets", "pyspy.icns")
+ABOUT_ICON = os.path.join("assets", "pyspy_mid.png")
+
+block_cipher = None
+
+a = Analysis(
+    ["__main__.py"],
+    pathex=[os.getcwd()],
+    binaries=[],
+    datas=[
+        (ICON_FILE, ""),
+        (ABOUT_ICON, ""),
+        ("VERSION", ""),
+        ("LICENSE.txt", ""),
+        ],
+    hiddenimports=[],
+    hookspath=[],
+    runtime_hooks=[],
+    excludes=["Tkinter"],
+    win_no_prefer_redirects=False,
+    win_private_assemblies=False,
+    cipher=block_cipher
+    )
+
+pyz = PYZ(
+    a.pure,
+    a.zipped_data,
+    cipher=block_cipher
+    )
+
+exe = EXE(
+    pyz,
+    a.scripts,
+    a.binaries,
+    a.zipfiles,
+    a.datas,
+    name="PySpy",
+    icon=ICON_FILE,
+    debug=False,
+    strip=False,
+    upx=True,
+    runtime_tmpdir=None,
+    console=False,
+    noconsole=True,
+    onefile=True,
+    windowed=True
+    )
+
+app = BUNDLE(
+    exe,
+    name="PySpy.app",
+    icon=MAC_ICON,
+    bundle_identifier=None
+    )

aboutdialog.py

@@ -0,0 +1,55 @@
+# !/usr/local/bin/python3.6
+# MIT licensed
+# Copyright (c) 2018 White Russsian
+# Github: <https://github.com/WhiteRusssian/PySpy>**********************
+'''The About Dialog for PySpy's GUI. OnAboutBox() gets called by the GUI
+module.'''
+# **********************************************************************
+import logging
+import time
+
+import wx
+import wx.adv
+
+import __main__
+import config
+# cSpell Checker - Correct Words****************************************
+# // cSpell:words russsian, wxpython, ccp's
+# // cSpell:words
+# **********************************************************************
+Logger = logging.getLogger(__name__)
+# Example call: Logger.info("Something badhappened", exc_info=True) ****
+
+
+def OnAboutBox(e):
+    # __main__.app.PySpy.ToggleWindowStyle(wx.STAY_ON_TOP)
+
+    description = """
+    PySpy is a a simple EVE Online character intel tool
+    using CCP's ESI API.
+
+    If you enjoy PySpy and want to show your appreciation
+    to its author, you are welcome to send an ISK donation
+    in-game to White Russsian (with 3 "s").
+
+    Thank you."""
+
+    try:
+        with open(config.resource_path('LICENSE.txt'), 'r') as lic_file:
+            license = lic_file.read()
+    except:
+        license = "PySpy is licensed under the MIT License."
+
+    info = wx.adv.AboutDialogInfo()
+
+    info.SetIcon(wx.Icon(config.ABOUT_ICON, wx.BITMAP_TYPE_PNG))
+    info.SetName('PySpy')
+    info.SetVersion(config.CURRENT_VER)
+    info.SetDescription(description)
+    info.SetCopyright('(C) 2018 White Russsian')
+    info.SetWebSite('https://github.com/WhiteRusssian/PySpy')
+    info.SetLicence(license)
+
+    wx.adv.AboutBox(info)
+
+    # __main__.app.PySpy.SetWindowStyle(wx.STAY_ON_TOP)