tmuxcontrollib: Instructions file for Claude Code

TmuxControlLib Development Guide

Build & Run Commands

# Install dependencies and package in development mode
poetry install

# Format code
poetry run black tmuxcontrollib/
poetry run isort tmuxcontrollib/

# Type checking
poetry run mypy tmuxcontrollib/

# Run all tests
poetry run pytest tests/

# Run a single test
poetry run pytest tests/test_file.py::test_function_name -v

# Run the CLI
poetry run tmuxcontrollib

# Build package
poetry build

Code Style Guidelines

• Imports: Use isort with Black profile. Group stdlib, third-party, local imports.
• Formatting: Follow Black with 88 char line length. Docstrings use """triple quotes""".
• Types: Use type annotations throughout. Enable mypy strict mode in new modules.
• Naming:
  • Classes: PascalCase
  • Functions/variables: snake_case
  • Constants: UPPER_SNAKE_CASE
• Error handling: Use specific exceptions with descriptive messages.
• Self-documenting: Make code descriptive with clear function/variable names.
• Documentation: Include docstrings for all public modules, classes, and functions.
• Keep running documentation of larger architecture concerns in the docs directory.

Project Structure

• tmuxcontrollib/: Main package directory
  • tmux_control/: The tmux control module
  • cli.py: CLI implementation
  • tui.py: Text UI implementation
  • main.py: Entry point for the application
• tests/: Test directory mirroring the package structure
• Use poetry for dependency management and package publishing.