Splatlogger 1.6__tar.gz → 1.6.1__tar.gz

{splatlogger-1.6 → splatlogger-1.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Splatlogger
-Version: 1.6
+Version: 1.6.1
 Summary: A CLI PID (Principal ID)/PNID grabber and match logger for Splatoon.
 Author-email: Shadow Doggo <shadowdoggo@protonmail.com>
 License-Expression: MIT
@@ -18,36 +18,44 @@ Requires-Dist: pymemoryeditor
 A CLI PID (Principal ID)/PNID grabber and match logger for Splatoon, written in Python.
 
 ## Prerequisites
-To install the package, you'll need to have Python 3.11 or newer installed on your system
-(on Android devices you can use Termux).
+To install the package, you'll need to have Python 3.11 or newer installed on your system.
+On Android devices you can use Termux.
 Python is not required for the Windows executable.
 
 Both the Wii U and Cemu (Windows and Linux only) are supported.
 
-Your Wii U will need to have either the Tiramisu or Aroma environment set up or have another way to run homebrew
-(e.g. Haxchi, browser exploit).
+Your Wii U will need to have either the Tiramisu or Aroma environment set up or have another way to run homebrew,
+such as Haxchi or the browser exploit.
 
-On Tiramisu, use [TCPGecko](https://github.com/BullyWiiPlaza/tcpgecko) (Geckiine or SDGeckiine will work as well).
+On Tiramisu, use [TCPGecko](https://github.com/BullyWiiPlaza/tcpgecko), [Geckiine](https://hb-app.store/wiiu/geckiine),
+or any other app with the TCPGecko server.
 
 On Aroma, install the [TCPGecko Aroma plugin](https://codeberg.org/ShadowDoggo/TCPGeckoAroma).
 
 ## Installation
+On Windows, you can use the executable provided on the releases page.
+Though if you already have Python installed, it's recommended to use the package.
+
 To install the package from PyPI, run:
 ```
 python -m pip install Splatlogger
 ```
 
-Or download the latest release from GitHub and run:
+Or download the latest release from Codeberg and run:
 ```
-python -m pip install /path/to/Splatlogger-1.x.zip
+python -m pip install path/to/Splatlogger-v1.x.zip
 ```
 
-On Windows, use the executable provided on the releases page.
-Though if you already have Python installed, it's recommended to use the package.
+If you do have Python installed but do not wish to install the package, you can run the module directly from the source code.
+
+Install the required dependencies:
+```
+cd path/to/Splatlogger-v1.x/ && pip install -r requirements.txt
+```
 
-If you do have Python installed but do not wish to install the package, you can run the module directly from the source code:
+Then run the module:
 ```
-cd /path/to/Splatlogger-1.x/src && python -m splatlogger
+cd src/ && python -m splatlogger
 ```
 
 ## Usage
@@ -60,7 +68,7 @@ where `IP` is your Wii U's LAN IP address
 
 If using the Windows executable, run:
 ```
-/path/to/Splatlogger-1.x.exe -ip IP [options]
+path/to/Splatlogger-1.x.exe -ip IP [options]
 ```
 
 Options:

{splatlogger-1.6 → splatlogger-1.6.1}/README.md

@@ -2,36 +2,44 @@
 A CLI PID (Principal ID)/PNID grabber and match logger for Splatoon, written in Python.
 
 ## Prerequisites
-To install the package, you'll need to have Python 3.11 or newer installed on your system
-(on Android devices you can use Termux).
+To install the package, you'll need to have Python 3.11 or newer installed on your system.
+On Android devices you can use Termux.
 Python is not required for the Windows executable.
 
 Both the Wii U and Cemu (Windows and Linux only) are supported.
 
-Your Wii U will need to have either the Tiramisu or Aroma environment set up or have another way to run homebrew
-(e.g. Haxchi, browser exploit).
+Your Wii U will need to have either the Tiramisu or Aroma environment set up or have another way to run homebrew,
+such as Haxchi or the browser exploit.
 
-On Tiramisu, use [TCPGecko](https://github.com/BullyWiiPlaza/tcpgecko) (Geckiine or SDGeckiine will work as well).
+On Tiramisu, use [TCPGecko](https://github.com/BullyWiiPlaza/tcpgecko), [Geckiine](https://hb-app.store/wiiu/geckiine),
+or any other app with the TCPGecko server.
 
 On Aroma, install the [TCPGecko Aroma plugin](https://codeberg.org/ShadowDoggo/TCPGeckoAroma).
 
 ## Installation
+On Windows, you can use the executable provided on the releases page.
+Though if you already have Python installed, it's recommended to use the package.
+
 To install the package from PyPI, run:
 ```
 python -m pip install Splatlogger
 ```
 
-Or download the latest release from GitHub and run:
+Or download the latest release from Codeberg and run:
 ```
-python -m pip install /path/to/Splatlogger-1.x.zip
+python -m pip install path/to/Splatlogger-v1.x.zip
 ```
 
-On Windows, use the executable provided on the releases page.
-Though if you already have Python installed, it's recommended to use the package.
+If you do have Python installed but do not wish to install the package, you can run the module directly from the source code.
+
+Install the required dependencies:
+```
+cd path/to/Splatlogger-v1.x/ && pip install -r requirements.txt
+```
 
-If you do have Python installed but do not wish to install the package, you can run the module directly from the source code:
+Then run the module:
 ```
-cd /path/to/Splatlogger-1.x/src && python -m splatlogger
+cd src/ && python -m splatlogger
 ```
 
 ## Usage
@@ -44,7 +52,7 @@ where `IP` is your Wii U's LAN IP address
 
 If using the Windows executable, run:
 ```
-/path/to/Splatlogger-1.x.exe -ip IP [options]
+path/to/Splatlogger-1.x.exe -ip IP [options]
 ```
 
 Options:

{splatlogger-1.6 → splatlogger-1.6.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "Splatlogger"
-version = "1.6"
+version = "1.6.1"
 authors = [
     { name="Shadow Doggo", email="shadowdoggo@protonmail.com" }
 ]

{splatlogger-1.6 → splatlogger-1.6.1}/src/Splatlogger.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Splatlogger
-Version: 1.6
+Version: 1.6.1
 Summary: A CLI PID (Principal ID)/PNID grabber and match logger for Splatoon.
 Author-email: Shadow Doggo <shadowdoggo@protonmail.com>
 License-Expression: MIT
@@ -18,36 +18,44 @@ Requires-Dist: pymemoryeditor
 A CLI PID (Principal ID)/PNID grabber and match logger for Splatoon, written in Python.
 
 ## Prerequisites
-To install the package, you'll need to have Python 3.11 or newer installed on your system
-(on Android devices you can use Termux).
+To install the package, you'll need to have Python 3.11 or newer installed on your system.
+On Android devices you can use Termux.
 Python is not required for the Windows executable.
 
 Both the Wii U and Cemu (Windows and Linux only) are supported.
 
-Your Wii U will need to have either the Tiramisu or Aroma environment set up or have another way to run homebrew
-(e.g. Haxchi, browser exploit).
+Your Wii U will need to have either the Tiramisu or Aroma environment set up or have another way to run homebrew,
+such as Haxchi or the browser exploit.
 
-On Tiramisu, use [TCPGecko](https://github.com/BullyWiiPlaza/tcpgecko) (Geckiine or SDGeckiine will work as well).
+On Tiramisu, use [TCPGecko](https://github.com/BullyWiiPlaza/tcpgecko), [Geckiine](https://hb-app.store/wiiu/geckiine),
+or any other app with the TCPGecko server.
 
 On Aroma, install the [TCPGecko Aroma plugin](https://codeberg.org/ShadowDoggo/TCPGeckoAroma).
 
 ## Installation
+On Windows, you can use the executable provided on the releases page.
+Though if you already have Python installed, it's recommended to use the package.
+
 To install the package from PyPI, run:
 ```
 python -m pip install Splatlogger
 ```
 
-Or download the latest release from GitHub and run:
+Or download the latest release from Codeberg and run:
 ```
-python -m pip install /path/to/Splatlogger-1.x.zip
+python -m pip install path/to/Splatlogger-v1.x.zip
 ```
 
-On Windows, use the executable provided on the releases page.
-Though if you already have Python installed, it's recommended to use the package.
+If you do have Python installed but do not wish to install the package, you can run the module directly from the source code.
+
+Install the required dependencies:
+```
+cd path/to/Splatlogger-v1.x/ && pip install -r requirements.txt
+```
 
-If you do have Python installed but do not wish to install the package, you can run the module directly from the source code:
+Then run the module:
 ```
-cd /path/to/Splatlogger-1.x/src && python -m splatlogger
+cd src/ && python -m splatlogger
 ```
 
 ## Usage
@@ -60,7 +68,7 @@ where `IP` is your Wii U's LAN IP address
 
 If using the Windows executable, run:
 ```
-/path/to/Splatlogger-1.x.exe -ip IP [options]
+path/to/Splatlogger-1.x.exe -ip IP [options]
 ```
 
 Options:

{splatlogger-1.6 → splatlogger-1.6.1}/src/splatlogger/__main__.py

@@ -5,6 +5,7 @@ import ipaddress
 import os
 import sys
 import time
+import webbrowser
 from datetime import datetime
 from typing import NamedTuple
 from xml.etree import ElementTree
@@ -18,7 +19,7 @@ from .match_logger import MatchLogger
 from .tcpgecko import TCPGecko, TCPGeckoException
 from .tcpgecko_aroma import TCPGeckoAroma
 
-_VERSION = "1.6"
+_VERSION = "1.6.1"
 
 
 class Options(NamedTuple):
@@ -63,6 +64,14 @@ def main() -> None:
     else:
         args = parser.parse_args()
 
+    if len(sys.argv) == 1:
+        print('No arguments were provided. Run "splatlogger -h" for help.')
+        print("Would you like to open the README? (y/n)")
+        if input().lower() == "y":
+            webbrowser.open("https://codeberg.org/ShadowDoggo/Splatlogger/src/branch/main/README.md")
+
+        sys.exit()
+
     if args.aroma and args.cemu:
         print("Cannot use both Aroma and Cemu modes.")
         sys.exit()
@@ -97,9 +106,6 @@ def main() -> None:
             print(e)
             sys.exit()
     else:
-        if not args.ip:
-            print('No IP address was provided. Run "splatlogger -h" for help.')
-            sys.exit()
         try:
             ipaddress.ip_address(args.ip)
             print(f"Connecting to: {args.ip}")