Skip to content

index.md

Latest commit

 

History

History
32 lines (23 loc) · 1.74 KB

index.md

File metadata and controls

32 lines (23 loc) · 1.74 KB
Raw
okf_version 0.1

Portable Python — Knowledge Bundle

A knowledge bundle (in OKF format) describing portable-python: a CLI and Python library for compiling statically-linked, relocatable CPython binaries from source.

Start with the Overview, then drill into the area you need.

Sections

  • Overview - What portable-python does, its guiding principles, and how a build flows end to end.
  • Concepts - Domain ideas: portability, static linking, telltale detection, folder masking, build layout.
  • Architecture - The core classes and how they collaborate during a build.
  • CLI - The portable-python subcommands and their options.
  • External Modules - The C libraries compiled and statically linked into CPython.
  • Configuration - The portable-python.yml file, its sections and overrides.
  • Guides - Playbooks for common tasks: building, extending, local development.
  • Release process - How to cut a release: changelog highlights, then a version tag.
  • Changelog - High-level release highlights, newest first.

Conventions

  • Concept IDs are file paths minus .md (e.g. architecture/ppg).
  • Cross-links are bundle-relative, beginning with / (the bundle root is this docs/ folder).* Change history lives in log.md.

Authority

This bundle is the authoritative documentation for portable-python's internals, configuration, CLI, and development workflows. The repository's README.rst remains the project's landing page (install, quick start, motivation).