Skip to content

CLAUDE.md

Latest commit

 

History

History
73 lines (52 loc) · 3.8 KB

CLAUDE.md

File metadata and controls

73 lines (52 loc) · 3.8 KB
Raw

CLAUDE.md

Project-level instructions for Claude Code when working in this repository.

Project Overview

This is a minimal "Hello World" Python program that serves as a test and reference for a basic Claude Code Python repository. It prints the string Hello World! to the terminal, with one new line before the message and a blank line left after the message.

Architecture

  • main.py — Program entry point. Defines a main function that creates an instance of the Application class named application, and then calls application.run. Guarded by if __name__ == "__main__":.
  • application.py — Defines the Application class. The class exposes a single run method, which prints Hello World! to the terminal.

Running

python main.py

Expected output (note the leading blank line and the blank line left after the message):


Hello World!

Coding Standards

Follow the conventions in ~/.claude/coding-standards.md. For this project specifically:

  • 4-space indentation, no tabs.
  • Spaces inside parentheses (older spaced style): print ( "..." ), def run ( self ):.
  • snake_case for variables and functions, PascalCase for classes, UPPER_SNAKE_CASE for constants.
  • Structured #-banner file headers and method/function documentation blocks.
  • # Return to caller. comment before return statements.
  • Main guard (if __name__ == "__main__":) always present.

Release Archives

Files to include in and exclude from the source code zip and tar archives for GitHub releases.

Included

┌──────────────────┬────────────────────────────────────────────────────────┐ │ File / Pattern │ Description │ ├──────────────────┼────────────────────────────────────────────────────────┤ │ main.py │ Program entry point. Creates and runs the Application. │ │ application.py │ Application class definition. │ │ run.sh │ Shell launcher that runs main.py. │ │ README.md │ Project documentation. │ │ LICENSE │ MIT license text. │ │ requirements.txt │ Dependency manifest (standard library only). │ │ .gitignore │ Git ignore rules. │ │ CLAUDE.md │ Claude Code project instructions. │ └──────────────────┴────────────────────────────────────────────────────────┘

Excluded

┌──────────────────┬─────────────────────────────────┐ │ File / Pattern │ Reason │ ├──────────────────┼─────────────────────────────────┤ │ pycache/ │ Compiled Python bytecode cache. │ │ *.pyc │ Compiled Python bytecode files. │ │ .venv/, venv/ │ Local virtual environments. │ │ .vscode/, .idea/ │ Editor and IDE settings. │ │ .git/ │ Version control metadata. │ └──────────────────┴─────────────────────────────────┘