Skip to content

CLAUDE.md

Latest commit

 

History

History
35 lines (29 loc) · 1.15 KB

CLAUDE.md

File metadata and controls

35 lines (29 loc) · 1.15 KB
Raw

CLAUDE.md — Python Utilities Project

Project Overview

This is a beginner Python project for practising Claude Code. The project contains simple Python utility scripts for a basic calculator.

Coding Standards

  • Use Python 3.10+
  • Follow PEP 8 style guidelines
  • Add a docstring to every function
  • Use type hints for all function parameters and return values
  • Keep functions small and focused (one task per function)
  • Use f-strings for all string formatting

Testing

  • Write tests using the built-in unittest module
  • Name test files as test_<module_name>.py
  • Run tests with: python -m unittest discover

Project Structure

python_utils/
├── CLAUDE.md          ← You are here (AI instruction file)
├── app.py             ← Main calculator script
└── tests/             ← Test files go here

Off-Limits Files

  • Do NOT modify CLAUDE.md unless explicitly asked
  • Do NOT delete any existing files without confirmation

Notes for Claude Code

  • Always explain what you are about to do before making changes
  • Prefer simple, readable solutions over clever ones
  • This project is for beginners — keep code easy to understand