Add support for installing via Scoop on Windows

Open
  • Is something wrong?
#72 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
55/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
python, shell
Domain
release

Research direction

Start from the existing Windows PowerShell bootstrap and its installer contract tests to see how install, update ownership, startup entry and uninstall are currently handled, plus how the built-in self-updater detects its runtime. Check whether the repo already cuts versioned GitHub releases/tags (referenced against #71 for the Homebrew equivalent). Done looks like: a token-meter Scoop manifest pinned to a versioned URL with SHA-256 and declared prerequisites, contract tests covering per-user paths, update ownership (Scoop-owned installs skip the self-updater) and uninstall ownership, and install/update/uninstall docs beside the Windows bootstrap section; note Windows-native validation is required.

Written by the indexing model from the issue text.

Description

Windows users can currently install Token Meter through the PowerShell bootstrap, which uses WinGet for prerequisites. Scoop users need a package-managed path with a stable artifact and one clear owner for updates.

Related: #71 proposes the equivalent Homebrew work.

Proposed behavior

  1. Cut versioned GitHub releases/tags so a Scoop manifest can pin a stable archive URL and SHA-256 checksum. Do not have the manifest track main.
  2. Publish a token-meter Scoop manifest in a Splunk-managed bucket, or document the selected bucket before adding the manifest.
  3. Declare the supported runtime prerequisites in the manifest. Installation must remain per-user, require no administrator access, and preserve the existing Windows local-only server and notification-area behavior.
  4. Make the Scoop installation lifecycle package-aware: scoop update token-meter owns application updates. A Scoop-installed runtime must not also fetch, fast-forward, or reinstall itself through the built-in updater.
  5. Ensure uninstall removes only Token Meter resources it owns, including its current-user startup entry and managed runtime, without removing user session evidence or unrelated Scoop-managed dependencies.
  6. Document the Scoop install, update, and uninstall flows alongside the existing Windows bootstrap path.

Validation

  • Add manifest and installer contracts covering the versioned URL, checksum, dependencies, per-user paths, update ownership, and uninstall ownership.
  • On a clean Windows host, validate scoop install token-meter, launch/readiness (/health and /menubar), current-user startup, scoop update token-meter, and scoop uninstall token-meter.
  • Windows-native Scoop validation is pending; macOS source checks do not prove PowerShell, Scoop, registry-startup, or notification-area behavior.

No dashboard UI addition or privacy-boundary change is intended.

Dominant language
Python
Stars
146
Forks
34
Avg merge
14h 35m
Merged PRs (30d)
64

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from splunk/token-meter

All issues in splunk/token-meter

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.