Skip to main content

---

title: "Configure logging" component_type: script version: "1.0.0" audience: contributor status: stable summary: "CODITECT Interactive Project Setup" keywords: ['analysis', 'api', 'backend', 'coditect', 'database'] tokens: ~500 created: 2025-12-22 updated: 2025-12-22 script_name: "coditect-interactive-setup.py" language: python executable: true usage: "python3 scripts/coditect-interactive-setup.py [options]" python_version: "3.10+" dependencies: [] modifies_files: false network_access: false requires_auth: false​

CODITECT Interactive Project Setup

Interactive Python script to set up a new CODITECT project with:

  • Custom project directory selection
  • Automated .coditect framework installation
  • context-storage structure creation
  • Sample project initialization
  • Initial documentation generation

Usage: python3 coditect-interactive-setup.py

Or make executable: chmod +x coditect-interactive-setup.py ./coditect-interactive-setup.py

File: coditect-interactive-setup.py

Classes​

CoditectSetupError​

Base exception for CODITECT setup errors

PrerequisiteError​

Raised when required tools are missing

DirectoryCreationError​

Raised when directory creation fails

GitOperationError​

Raised when git operations fail

FrameworkInstallError​

Raised when framework installation fails

DocumentationError​

Raised when documentation creation fails

Colors​

No description

Functions​

parse_args()​

Parse command line arguments

Print a formatted header message.

Print a success message.

Print an error message.

Print an info message.

Print a warning message.

run_command(cmd, cwd, check)​

Run a shell command and return the result.

check_prerequisites()​

Check if required tools are installed.

get_project_directory()​

Interactive prompt for project directory path.

get_project_info()​

Interactive prompt for project information.

create_directory_structure(project_path)​

Create the project directory structure.

install_coditect_framework(project_path)​

Install .coditect framework as git submodule.

create_initial_documentation(project_path, project_info)​

Create initial project documentation.

create_gitignore(project_path)​

Create a sensible .gitignore file.

initial_git_commit(project_path, project_info)​

Create initial git commit.

Usage​

python coditect-interactive-setup.py