Skip to main content

Heaptree | Launch Virtual Machines With One Line of Code

Project description

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. Get your API key

Sign up at heaptree.com and copy your API key from the dashboard.

3. Set your API key

Set your API key as an environment variable.

HEAPTREE_API_KEY=your_api_key_here

4. 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(
    os="linux",
    num_nodes=1,
    node_type="ubuntu",
    node_size="small"
)

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

5. 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

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.

Project details


Download files

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

Source Distribution

htsdk-0.1.0b8.tar.gz (13.3 kB view details)

Uploaded Source

Built Distribution

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

htsdk-0.1.0b8-py3-none-any.whl (11.7 kB view details)

Uploaded Python 3

File details

Details for the file htsdk-0.1.0b8.tar.gz.

File metadata

  • Download URL: htsdk-0.1.0b8.tar.gz
  • Upload date:
  • Size: 13.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for htsdk-0.1.0b8.tar.gz
Algorithm Hash digest
SHA256 8f1f2da75602adb650cd846ae23192c9cbffaf6bf0e8efdc5feb7da7ea9d4f03
MD5 471b75a4f43eb709d5c5beab56b94e94
BLAKE2b-256 f37ec420a4278cb166dd3ad9a91f292d9f503bc6de214fb56b1f73f948218f21

See more details on using hashes here.

File details

Details for the file htsdk-0.1.0b8-py3-none-any.whl.

File metadata

  • Download URL: htsdk-0.1.0b8-py3-none-any.whl
  • Upload date:
  • Size: 11.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for htsdk-0.1.0b8-py3-none-any.whl
Algorithm Hash digest
SHA256 4b6d0d88073d187c1d85c934ed26987733931fedc02ebd853c2ae9a1fa155049
MD5 2a3d1a26f66401c46f5a82a0cea51214
BLAKE2b-256 317a413ee815fb2c0d2a94f7e1624b4b9154a2beb2763ad30298c9f376f1438b

See more details on using hashes here.

Supported by

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