deadline-cloud: Instructions file for Codex

AGENTS.md - AWS Deadline Cloud Client

This document provides guidance for AI agents working with this codebase.

Project Overview

AWS Deadline Cloud client is a Python library and CLI tool for interacting with AWS Deadline Cloud. It supports job submission, file transfer via job attachments, and provides both CLI and GUI interfaces.

Package name: deadline Platforms: Linux, Windows, macOS

Repository Structure

src/deadline/
├── client/           # Main client library
│   ├── api/          # Boto3 wrappers and AWS API helpers
│   ├── cli/          # CLI entry points (deadline command)
│   ├── config/       # Configuration (~/.deadline/*)
│   ├── ui/           # Qt/PySide GUI components
│   ├── job_bundle/   # Job bundle handling and history
│   └── dataclasses/  # Data structures
├── mcp/              # MCP server (public)
├── _mcp/             # MCP server (internal)
└── common/           # Shared utilities

Key Commands

Always use hatch for running builds, tests, formatting, and linting. If running just a few tests, always add --numprocesses=1 to the hatch run test command so that it starts quicker.

# Development
hatch build              # Build wheel/sdist
hatch run test           # Run unit tests
hatch run test --numprocesses=1 -k "selected_test_name" # Run just a few tests
hatch run all:test       # Test all Python versions
hatch run integ:test     # Integration tests (requires AWS)
hatch run lint           # Check formatting
hatch run fmt            # Auto-format code
hatch shell              # Enter dev environment

# CLI usage
deadline farm list
deadline bundle submit <path>
deadline job list
deadline job get
deadline job logs --job-id <id>

Code Conventions

Module Naming

• Private modules: _module.py - internal implementation
• Public modules: module.py - part of public API
• Symbols not starting with _ define the public contract