Skip to main content

Poks

CI Status Test coverage percentage

uv Ruff pypeline pre-commit

PyPI Version Supported Python versions License


Source Code: https://github.com/cuinixam/poks


A lightweight, cross-platform archive downloader for pre-built binary dependencies. Inspired by Scoop, Poks provides a uniform way to install and manage developer tools using simple JSON manifests.

While Poks includes a CLI, its main purpose is to be used programmatically to manage dependencies in your Python projects and automation scripts.

Features

  • Programmatic API: First-class Python support for integrating into your tools
  • Cross-Platform: Works on Windows, Linux, and macOS
  • No Admin Rights: Installs tools in user space
  • Deterministic: Pin exact versions in manifests for reproducible builds
  • Relocatable: The apps directory is self-contained and portable

Installation

pip install poks

For CLI-only usage:

pipx install poks

Concepts

  • App: A tool or dependency you want to install (e.g., CMake, a compiler toolchain). Each app has a name and one or more versions.
  • Manifest: A JSON file that describes an app — its download URLs, checksums, and platform-specific archives. One manifest per app (e.g., cmake.json). See examples/cmake.json.
  • Bucket: A git repository containing a collection of manifests. Buckets are how manifests are shared and distributed.
  • Config file: A JSON file (poks.json) that ties it all together — it lists which buckets to use and which apps (with versions) to install from them. See examples/poks.json.

Installing apps

From a config file

Use a config file when you want to define a reproducible set of tools for a project. The config references one or more buckets and lists the apps to install from them.

poks install --config poks.json

From a bucket

Install a single app directly, without a config file. Poks looks up the app's manifest in the specified bucket.

poks install --app cmake --version 3.28.1 --bucket main
poks install --app cmake --version 3.28.1 --bucket https://github.com/poks/main-bucket.git
poks install --app cmake --version 3.28.1   # searches all local buckets

From a manifest file

Install directly from a local manifest file — no bucket needed. Useful for testing a manifest before publishing it to a bucket. The app name is derived from the filename.

poks install --manifest cmake.json --version 4.2.3

Platform filtering

Apps in a config file can be restricted to specific operating systems or architectures using the os and arch fields. Apps that don't match the current platform are silently skipped.

{
    "apps": [
        { "name": "cmake", "version": "3.28.1", "bucket": "main" },
        { "name": "mingw-tools", "version": "1.0.0", "bucket": "extras", "os": ["windows"] },
        { "name": "build-essential", "version": "1.0.0", "bucket": "extras", "os": ["linux", "macos"] }
    ]
}

Supported values — os: windows, linux, macos; arch: x86_64, aarch64. When omitted, the app is installed on all platforms.

Other commands

poks uninstall cmake@3.28.1       # specific version
poks uninstall cmake              # all versions
poks uninstall --all              # everything
poks search cmake                 # search across local buckets
poks list                         # list installed apps
poks unpack archive.tar.gz -o ./out  # extract an archive directly
poks convert-scoop manifest.json  # convert a Scoop manifest to Poks format

Python API

Poks is designed to be used programmatically. See examples/ for complete scripts.

from pathlib import Path
from poks.poks import Poks

poks = Poks(root_dir=Path.home() / ".poks")

poks.install(Path("poks.json"))                              # from config file
poks.install_app("cmake", "3.28.1", bucket="main")           # from bucket
poks.install_from_manifest(Path("cmake.json"), "3.28.1")     # from manifest file

Manifest format

For the manifest schema and detailed specifications, see docs/specs.md.

Contributing

This project uses pypeline for build automation and uv for dependency management.

# Install pypeline
uv tool install pypeline-runner

# Run full pipeline (lint + tests)
pypeline run

For AI agents, see AGENTS.md.

Credits

Copier

This package was created with Copier and the browniebroke/pypackage-template project template.

Download files

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

Source Distribution

poks-0.11.1.tar.gz (25.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

poks-0.11.1-py3-none-any.whl (27.8 kB view details)

Uploaded Python 3

File details

Details for the file poks-0.11.1.tar.gz.

File metadata

  • Download URL: poks-0.11.1.tar.gz
  • Upload date:
  • Size: 25.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for poks-0.11.1.tar.gz
Algorithm Hash digest
SHA256 1248c470d6bc7a97ea375e7afb774d3956c7c3ec51f6d11d6bfd7f3debd904af
MD5 7a3150161671e3ab2ea98057466ff9b1
BLAKE2b-256 a42056ebe9b8b7607e775a5c8a1977ecb4555346a95f27212d329a642e1ce550

See more details on using hashes here.

Provenance

The following attestation bundles were made for poks-0.11.1.tar.gz:

Publisher: ci.yml on cuinixam/poks

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file poks-0.11.1-py3-none-any.whl.

File metadata

  • Download URL: poks-0.11.1-py3-none-any.whl
  • Upload date:
  • Size: 27.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for poks-0.11.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d3ede0a3d449ba456510be03d91c554f96ff8cd55e08b5494e2d2942ab54070e
MD5 0eede43637207d0923a811c452afa815
BLAKE2b-256 91e89677a57ef26c79dad2056c79758170c085fc5387be5920387bc6420b1f4d

See more details on using hashes here.

Provenance

The following attestation bundles were made for poks-0.11.1-py3-none-any.whl:

Publisher: ci.yml on cuinixam/poks

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.11.1 This release

2 files

0.11.0

2 files

0.10.1

2 files

0.10.0

2 files

0.9.4

2 files

0.9.3

2 files

0.9.2

2 files

0.9.1

2 files

0.9.0

2 files

0.8.0

2 files

0.7.0

2 files

0.6.0

2 files

0.5.0

2 files

0.4.0

2 files

0.3.0

2 files

0.2.1

2 files

0.2.0

2 files

0.1.0

2 files

0.0.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page