ork.build 0.0.288.dev2

Orkid Build Tools

OBT (Orkid Build Tool)

Build environment orchestrator for complex multi-language projects

---

What is OBT?

OBT manages build environments for complex software projects with extensive dependency trees. Unlike package managers that install system-wide, OBT creates isolated staging environments where all your project dependencies coexist without polluting your system.

Key Features

• 🔧 100+ Pre-configured Dependencies - Boost, Qt5, OpenCV, LLVM, and more
• 🎯 Project Composition - Combine multiple projects with --project arguments
• 🌍 Cross-Platform - Identical commands on Linux, macOS, and WSL2
• 🏗️ Multi-Language - C++, Python, Rust, JavaScript, and more
• 📦 Isolated Environments - No system pollution, everything in staging directories
• 🎨 Extensible - Add custom dependencies and modules per project

---

Quick Start

# Install OBT
pip3 install ork.build

# Create environment
obt.env.create.py --stagedir ~/.obt-staging

# Launch with projects
obt.env.launch.py --stagedir ~/.obt-staging --numcores 16 \
  --project ~/projects/myproject \
  --project ~/projects/shared

# Build dependencies
obt.dep.build.py boost
obt.dep.build.py opencv

---

Documentation

Getting Started

• 📚 Quick Start Guide - Get up and running in minutes
• 🎯 Examples - Real-world usage patterns

Reference

• 📖 Technical Design Document - Architecture, concepts, and FAQ
• 🏗️ Project Composition - How projects integrate

Advanced Topics

• 🐳 Docker Support - Containerized development environments
• 🔮 Subspaces - Isolated execution environments
• ⚡ FPGA/Vivado - Hardware development support

---

Requirements

• Python 3.10+
• Virtual environment (PEP-668 compliance)
• Clean base shell environment (why?)

Platform-Specific

macOS: Xcode, Homebrew
Linux: Build essentials, sudo access
Windows: WSL2 with Ubuntu

---

Project Composition

Make any project OBT-aware by adding:

myproject/
├── obt.project/
│   ├── obt.manifest          # {"name": "myproject", "autoexec": "scripts/init_env.py"}
│   └── scripts/
│       └── init_env.py       # Environment setup script

Then compose multiple projects:

obt.env.launch.py --project project1 --project project2 --project project3

---

Philosophy

OBT doesn't replace package managers or build systems - it orchestrates them. When you need a library, you need it. OBT ensures you get it with the right version, in the right place, without breaking anything else.

---

Support

• Issues: GitHub Issues
• Discussions: GitHub Discussions

---

License

BSD 3-Clause License - See LICENSE and license.rst for details.

Copyright (c) 2010-2024, Michael T. Mayers. All rights reserved.