Skip to content

Commit 17849d4

Browse files
committed
docs: revamp README with hardware benchmarks and fix release packaging
- Rewrote README.md to highlight the sub-millisecond C-dispatcher, "God Mode" GPU IPC, and Rust FFI atomic swaps, stripping out outdated bloat. - Added `_help.py` and `_help.h` to `MANIFEST.in` and `pyproject.toml` to ensure the static help text ships properly in the PyPI source distribution. - Fixed a missing `is_interactive_session` import in `package_meta_builder.py`. - Updated the `8pkg demo` CLI boundaries to correctly accept Option 11 (Daemon IPC Showcase). - Updated Dependabot config to correctly exclude `licenses/` and `docker/` directories to prevent false-positive syntax crashes. Modified: • src/omnipkg/cli.py (+1/-1 lines) • src/omnipkg/package_meta_builder.py (+1/-1 lines) • .github/dependabot.yml (+2/-7 lines) • .gitignore (+3/-0 lines) • MANIFEST.in (+4/-0 lines) • pyproject.toml (+3/-0 lines) • src/omnipkg/conda-recipes/meta-platforms.yaml (+11/-15 lines) • README.md (+311/-1547 lines) [gitship-generated]
1 parent bf7d619 commit 17849d4

10 files changed

Lines changed: 213 additions & 1486 deletions

File tree

.github/dependabot.yml

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,6 @@ updates:
66
interval: "monthly"
77
ignore:
88
- dependency-name: "*"
9-
- package-ecosystem: "pip"
10-
directory: "/docker"
11-
schedule:
12-
interval: "monthly"
13-
ignore:
14-
- dependency-name: "*"
159
exclude-paths:
16-
- "licenses/**"
10+
- "licenses/**"
11+
- "docker/**"

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -210,6 +210,9 @@ src/omnipkg/_vendor/wheels/
210210
ci-wheel-cache/
211211
build/
212212

213+
# help text artifact
214+
/home/minds3t/omnipkg/src/omnipkg/help.toml
215+
213216
# Python cache
214217
__pycache__/
215218
*.pyc

MANIFEST.in

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,8 @@ recursive-include src/tests *.py
2020

2121
# Top-level module list
2222
include top_level.txt
23-
include build_hooks.py
23+
include build_hooks.py
24+
25+
# help text
26+
include src/omnipkg/_help.py
27+
include src/omnipkg/_help.h

README.md

Lines changed: 181 additions & 1455 deletions
Large diffs are not rendered by default.

pyproject.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,8 +159,11 @@ omnipkg = [
159159
"locales/**/*.mo",
160160
"locales/**/*.pot",
161161
"dispatcher.c",
162+
"_help.h",
163+
"_help.py",
162164
]
163165

166+
164167
[tool.setuptools]
165168
# Old setuptools format (compatible with setuptools 50.x)
166169
license-files = ["LICENSE", "COMMERCIAL_LICENSE.md"]

src/omnipkg/_help.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/* DO NOT EDIT — generated by dev_tools/gen_help.py from src/omnipkg/help.toml */
2-
/* source hash: af9d47a97c8d7a49 version: 3.3.5 */
2+
/* source hash: af9d47a97c8d7a49 version: 3.4.0 */
33
#ifndef OMNIPKG_HELP_H
44
#define OMNIPKG_HELP_H
55

@@ -53,7 +53,7 @@ static const char OMNIPKG_HELP_TEXT[] =
5353
" daemon start|stop|status manage background worker\n"
5454
" run <script|cmd> auto-healing script runner\n"
5555
"\n"
56-
"Version: 3.3.5\n"
56+
"Version: 3.4.0\n"
5757
"";
5858

5959
static const char OMNIPKG_HELP_CONFIG[] =
@@ -349,6 +349,6 @@ static const char OMNIPKG_HELP_WEB[] =
349349
"\n"
350350
"";
351351

352-
#define OMNIPKG_VERSION "3.3.5"
352+
#define OMNIPKG_VERSION "3.4.0"
353353

354354
#endif /* OMNIPKG_HELP_H */

src/omnipkg/_help.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# DO NOT EDIT — generated by dev_tools/gen_help.py from src/omnipkg/help.toml
2-
# source hash: af9d47a97c8d7a49 version: 3.3.5
2+
# source hash: af9d47a97c8d7a49 version: 3.4.0
33
"""Help text for omnipkg/8pkg, generated from help.toml at build time.
44
55
Import this module to get the pre-rendered help string without running
@@ -9,7 +9,7 @@
99
print(HELP_TEXT)
1010
"""
1111

12-
VERSION: str = "3.3.5"
12+
VERSION: str = "3.4.0"
1313

1414
HELP_TEXT: str = """\
1515
usage: 8pkg [-h] [-v] [--lang CODE] [--py VER] [-V] [-y] [-n] <command> ...
@@ -58,7 +58,7 @@
5858
daemon start|stop|status manage background worker
5959
run <script|cmd> auto-healing script runner
6060
61-
Version: 3.3.5
61+
Version: 3.4.0
6262
"""
6363

6464
SUBCOMMAND_HELP: dict[str, str] = {

src/omnipkg/cli.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2563,7 +2563,7 @@ def main():
25632563
non_interactive = not is_interactive_session()
25642564

25652565
if args.demo_id is not None:
2566-
if not (1 <= args.demo_id <= 10):
2566+
if not (1 <= args.demo_id <= 11):
25672567
safe_print(_("❌ Invalid demo ID {}. Choose 1-11.").format(args.demo_id))
25682568
return 1
25692569
response = str(args.demo_id)

src/omnipkg/conda-recipes/meta-platforms.yaml

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -65,26 +65,22 @@ about:
6565
license: AGPL-3.0-only
6666
license_family: AGPL
6767
license_file: LICENSE
68-
summary: 'The Ultimate Python Dependency Resolver. One environment. Infinite packages. Zero conflicts.'
68+
summary: 'Zero-overhead Python runtime hypervisor for concurrent, multi-version orchestration.'
6969
description: |
70-
OmniPkg is a distributed Python runtime hypervisor that enables concurrent,
71-
zero-copy multi-framework orchestration across multiple Python versions and toolchains.
70+
omnipkg is a persistent Python runtime hypervisor that executes conflicting package
71+
and interpreter versions concurrently within a single environment—in milliseconds.
7272
73-
Platform Support:
74-
- Linux: x86_64, aarch64/ARM64, ppc64le
75-
- macOS: x86_64 (Intel), arm64 (Apple Silicon)
76-
- Windows: x86_64, ARM64
73+
By separating the filesystem packaging structure from a persistent, memory-mapped
74+
runtime layer, omnipkg bypasses standard OS process-spawn constraints.
7775
7876
Key Features:
79-
- Reproducible State Engine with deterministic environment lockfiles (export/sync exact states)
80-
- Native C-Dispatcher: sub-millisecond command routing that bypasses Python startup overhead
81-
- Microsecond package activation via warm daemon workers (~50μs)
82-
- Persistent model tagging: keep full models loaded in memory and route commands repeatedly without reloads or 5-minute timeouts
83-
- Support for Python 3.7 through 3.15 in a single environment (far beyond Conda’s typical 3.10–3.13/3.14 range)
84-
- Concurrent multi-version package and interpreter loading
85-
- True zero-copy tensor passing across different Python versions, PyTorch/CUDA versions, and frameworks — no JSON serialization or process boundaries required
77+
- Zero-Overhead C-Dispatcher: Replaces the Python startup tax with a compiled C binary, routing commands via uint64_t word-loads in ~230µs.
78+
- True Zero-Copy GPU IPC ("God Mode"): Passes raw cudaIpcMemHandle pointers between isolated PyTorch workers. Move tensors across PyTorch 1.x and 2.x instances in ~4.5ms without data ever leaving VRAM.
79+
- Atomic Stash-Swaps via Rust FFI: Intercepts the `uv` installer's internal plan callbacks to atomically os.rename() directories in <1ms, creating instantly reversible environments.
80+
- Deep ABI Parsing: Natively parses .so ELF sections to extract NPY_FEATURE_VERSION, automatically injecting the correct NumPy ABI bubble before C-extension initialization.
81+
- Concurrent Python Interpreters: Hot-swap and execute across Python 3.7 through 3.15 simultaneously without containers or separate virtual environments.
8682
87-
Perfect for scientific computing, large model serving, and heterogeneous Python/CUDA workflows where maximum flexibility and minimal latency matter.
83+
Perfect for scientific computing, heterogeneous PyTorch/CUDA workflows, and AI infrastructure where maximum dependency flexibility and minimal latency matter.
8884
doc_url: https://omnipkg.readthedocs.io/en/latest/
8985
dev_url: https://github.com/1minds3t/omnipkg
9086

src/omnipkg/package_meta_builder.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
from __future__ import annotations # Python 3.6+ compatibility
22

3-
from omnipkg.common_utils import safe_print, _is_relative_to_win, _relative_to_win
3+
from omnipkg.common_utils import safe_print, _is_relative_to_win, _relative_to_win, is_interactive_session
44
from omnipkg.i18n import _
55

66
try:

0 commit comments

Comments
 (0)