Installation

# Install the cmdop SDK from PyPI using pip
pip install cmdop

# Add cmdop as a dependency using Poetry
poetry add cmdop

# Install cmdop into your Pipenv virtual environment
pipenv install cmdop

# Set your CMDOP API key as an environment variable
export CMDOP_API_KEY=cmd_xxx

import os
from cmdop import AsyncCMDOPClient
 
# Read the API key from the environment and create a remote client
client = AsyncCMDOPClient.remote(api_key=os.environ["CMDOP_API_KEY"])

from cmdop import AsyncCMDOPClient
 
# Pass the API key directly when creating the client
client = AsyncCMDOPClient.remote(api_key="cmd_xxx")

import asyncio
from cmdop import AsyncCMDOPClient
 
async def main():
    # Open an authenticated session to the CMDOP cloud
    async with AsyncCMDOPClient.remote(api_key="cmd_xxx") as client:
        # List all registered machines and their statuses
        machines = await client.machines.list()
        for machine in machines:
            print(f"{machine.hostname}: {machine.status}")
 
# Run the async verification function
asyncio.run(main())

# Install the SDK with optional type stub extras
pip install cmdop[types]

# Install mypy and gRPC type stubs for static analysis
pip install mypy types-grpcio

# Clone the repository and install in editable mode with dev dependencies
git clone https://github.com/commandoperator/cmdop-sdk
cd cmdop-sdk
pip install -e ".[dev]"

# Ensure pip is up to date
pip install --upgrade pip
 
# Reinstall the SDK cleanly
pip uninstall cmdop
pip install cmdop

# Install gRPC tools to resolve protobuf compilation issues
pip install grpcio-tools

# Update the certificate bundle to fix SSL verification failures
pip install certifi --upgrade