Skip to main content

A simple way to get live Halo data straight from Halo Waypoint.

Project description

HaloInfiniteGetter

A simple way to get live Halo data straight from Halo Waypoint.


MIT License

PyPI Python CPython


Note: This project is in a public alpha, and as such, many features are not complete.

About:

HaloInfiniteGetter is a GUI application written using PyQt6 that allows you to easily view data hosted on HaloWaypoint API endpoints.

You can view both Image and Text output, with these results being cached in the cwd under the hi_data folder, to eliminate unnecessary API calls.

How to use:

Installation:

  • First, install Python 3.10 using this link
  • Then, open command prompt (Win + R -- type in "cmd.exe") and type pip install hi_getter
    • Optionally, to install the latest unstable version, type pip install git+https://github.com/Cubicpath/HaloInfiniteGetter.git
  • And you are done! To launch the program simply type py -m hi_getter

Authentication:

As this app is unofficial, you must use your own API key, which you can get by logging in to HaloWaypoint and getting fata from the authentication headers.

Note: Auto-renewal of authentication keys is not currently implemented, so you will only be authenticated for a short amount of time.

Guide:

Example Request

  • Under the "Request Headers" right-click the "x-343-authorization-spartan" header and select Copy. Open the Settings window, Unlock the input by pressing the "Edit Auth Key" button, then paste the copied value.

Headers Settings

  • Press the Set button, and you should now be authenticated!

Searching:

Knowing where to search:

Input Section

An example resource (Progression/file/Calendars/Seasons/SeasonCalendar.json) is pre-filled out in the path input section.

You may omit progression/file/ and images/file/ from searches, so long as the file extension of the resource indicates data or media (ex: json defaults as progression/file/, png and jpg defaults as images/file/).

GET:

Gets the singular resource from the given path and outputs it.

SCAN:

Recursively scan a given JSON resource for paths to more resources, ignoring already scanned resources. This results in caching ALL resources that are referenced by any other resource with some tie to the original resource path.

Outputs the original resource's data.

Outputs:

Both the media and the text output can be detached and reattached from the main window. This allows greater flexibility, like viewing only the image in fullscreen.

Media Output:

(TODO)

Text Output:

(TODO)

Themes:

Themes are a way to style already-existing elements (Think CSS). They are held in a directory with their resources and stylesheet in the same folder level.

Theme file structure:

../
│
├───[theme_id]/
│       ├─── [icon1_name].svg
│       ├─── [icon2_name].svg
│       ├─── [icon3_name].svg
│       └─── [theme_id].qss
│

The current builtin themes are:

  • Breeze Dark
  • Breeze Light
  • Legacy (Default PyQt)

While the current breeze themes are slightly modified versions, and can view the original themes at BreezeStyleSheets.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hi_getter-0.4.2.tar.gz (62.2 kB view hashes)

Uploaded Source

Built Distribution

hi_getter-0.4.2-py3-none-any.whl (101.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page