Menu
Explore project structure to understand layout, packages, and key files. Use when you need context about how the project is organized.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
Google-style docstring conventions for Python code. Apply when writing or reviewing functions, classes, or modules that need documentation.
Python naming conventions for this codebase. Apply when writing or reviewing Python code including functions, classes, variables, and constants.
Python type hint conventions for this codebase. Apply when writing or reviewing Python code that needs type annotations on functions, classes, or variables.
Essential Pythonic idioms and conventions. Apply when writing or reviewing Python code to ensure idiomatic patterns like comprehensions, built-in functions, context managers, and unpacking.
Python code organization conventions for this codebase. Apply when structuring modules, organizing imports, designing file layouts, or moving functions/classes within or between files. Use PROACTIVELY when users request to check code organization, move code, or clean up and reorganize a module.
Refactoring complex functions into smaller, pure helper functions. Apply when function complexity is exceeded or when extracting helper functions during refactoring. If tasked with fixing ruff lint errors related to complexity, ALWAYS trigger this skill.
| name | explore-project |
| description | Explore project structure to understand layout, packages, and key files. Use when you need context about how the project is organized. |
| user-invocable | true |
Discover and understand the layout of any Python project. Use this when you need context about how the project is organized before making changes.
Run these commands to understand the project:
# 1. Top-level layout
ls -1 .
# 2. Project configuration
cat pyproject.toml # or setup.py, setup.cfg
# 3. Directory tree (2 levels deep, ignore noise)
find . -maxdepth 2 -type d \
-not -path './.git*' \
-not -path './.venv*' \
-not -path './venv*' \
-not -path './.claude*' \
-not -path './__pycache__*' \
-not -path './.mypy_cache*' \
-not -path './.pytest_cache*' \
-not -path './.ruff_cache*' \
-not -path './.tox*' \
-not -path './.nox*' \
-not -path './node_modules*' \
-not -path './dist*' \
-not -path './build*' \
-not -path './*.egg-info*' \
| sort
| Layout | How to Recognize | Entry Point |
|---|---|---|
| src layout | src/<package>/ with __init__.py | src/<package>/ |
| flat layout | <package>/ at root with __init__.py | <package>/ |
| single module | Standalone .py files at root | Root .py files |
Look for these common directories and understand their role:
| Directory | Typical Purpose |
|---|---|
tests/, test/ | Test suite |
docs/, doc/ | Documentation |
scripts/ | Utility/build scripts |
examples/ | Usage examples |
notebooks/ | Jupyter notebooks |
migrations/, alembic/ | Database migrations |
config/, conf/ | Configuration files |
data/ | Data files |
api/ | API definitions |
app/ | Application entry point |
| File | Manager |
|---|---|
pyproject.toml with [tool.uv] | uv |
pyproject.toml with [tool.poetry] | Poetry |
requirements.txt | pip |
Pipfile | pipenv |
setup.py / setup.cfg | setuptools |
Check pyproject.toml for:
[project.scripts] - CLI entry points[project.gui-scripts] - GUI entry points[tool.setuptools.packages] - Package discovery config