htsdk 0.1.0b10

Heaptree | Launch Virtual Machines With One Line of Code

What is Heaptree?

Heaptree lets you launch secure cloud instances with one line of code. Perfect for AI workloads, asynchronous tasks, or any application that needs on-demand compute.

Getting Started

1. Install the SDK

pip install htsdk

2. Login from your terminal

This opens your browser to sign in with GitHub/Google and automatically configures your API key.

heaptree login

This will:

• Save your key to ~/.heaptree/config.json
• Add HEAPTREE_API_KEY to your shell profile (e.g. ~/.zshrc)

Open a new terminal (or run source ~/.zshrc) for the environment change to take effect.

3. Create your first node

import os
from heaptree import Heaptree

# Initialize the client
client = Heaptree(api_key=os.getenv("HEAPTREE_API_KEY"))

# Create a new node
result = client.create_node(
    num_nodes=1,
    node_size="small"
)

print(f"Node created: {result.node_id}")

4. Use your node

# Run a command on the node
response = client.run_command(
    node_id=result.node_id,
    command="echo 'Hello from Heaptree!'"
)

# Clean up when done
client.terminate_node(result.node_id)

Updating the SDK

To update to the latest version of the SDK, run:

pip install --upgrade htsdk

Or use the shorthand:

pip install -U htsdk

To check your current SDK version:

pip show htsdk

Features

• Node Management: Create, terminate, and manage cloud instances
• File Operations: Upload and download files to/from nodes
• Command Execution: Run commands remotely on your nodes
• Multiple Node Support: Create and manage multiple nodes simultaneously

Git in Firecracker nodes

from heaptree import Heaptree

client = Heaptree(api_key=os.getenv("HEAPTREE_API_KEY"))
node = client.create_firecracker_node()

# Clone a public repo
node.git_clone(
    url="https://github.com/user/repo.git",
    path="workspace/repo"
)

# Clone with authentication (e.g., PAT)
node.git_clone(
    url="https://github.com/user/private-repo.git",
    path="workspace/private-repo",
    username="git",
    password="personal_access_token"
)

# Clone a specific branch
node.git_clone(
    url="https://github.com/user/repo.git",
    path="workspace/repo-branch",
    branch="develop"
)

# Get repo status
status = node.git_status("workspace/repo")
print(status.current_branch, status.ahead, status.behind)
for f in status.file_status:
    print(f.name, f.status)

# List branches
branches = node.git_branches("workspace/repo")
for b in branches.branches:
    print(b)

API Reference

For complete SDK documentation, including all available methods, parameters, and examples, visit the official documentation:

📖 Heaptree Documentation

License

This project is licensed under the MIT License - see the LICENSE file for details.