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.0b9.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.0b9-py3-none-any.whl (11.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: htsdk-0.1.0b9.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.0b9.tar.gz
Algorithm Hash digest
SHA256 dd220da7b7437669fa80e93fbbbccc5dd570914216fd174409217ecf59c52e3c
MD5 4a5b766561a3da38da1d61dd9f551c8f
BLAKE2b-256 bcc4a283bea9351abe1409764cd4dd5ccc6dadca741e9c9b6f145a6ead72bc78

See more details on using hashes here.

File details

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

File metadata

  • Download URL: htsdk-0.1.0b9-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.0b9-py3-none-any.whl
Algorithm Hash digest
SHA256 8585f84881d5a0e3f84acf87c613acc9fa58515e545633ae272148729b58d0c5
MD5 36dc2619eb177050abd0d38b12886fe0
BLAKE2b-256 7f0b124582ada699418b9a104a90d49a3c4f3ae51d7c7afd201f3b23f30b791c

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