Module Index

Complete map of Super Pocket modules so you know where to import from.

Package Layout

super_pocket/
├── cli.py                          # Main CLI entrypoint
├── interactive.py                  # Interactive prompt
├── markdown/
│   └── renderer.py                 # Markdown rendering
├── project/
│   ├── to_file.py                  # Export project to one Markdown
│   ├── req_to_date.py              # Dependency audit
│   └── init/                       # Project scaffolding
│       └── cli.py
├── readme/
│   ├── detector.py                 # Project detection
│   ├── generator.py                # README generation
│   └── cli.py                      # Analyze/generate commands
├── pdf/
│   └── converter.py                # Markdown/text to PDF
├── web/
│   ├── favicon.py                  # Favicon generation
│   └── job_search.py               # JSearch API wrapper
├── xml/
│   └── xml.py                      # tag:<content> to XML
├── documents/
│   ├── cli.py
│   ├── validator.py
│   ├── templates/
│   └── cheatsheets/
├── settings.py                     # Shared Click/Rich helpers
└── utils.py                        # Common error/printing helpers

Core Modules

Markdown Modules

Project Modules

README Modules

PDF Modules

Web Modules

Templates & Cheatsheets

XML Modules

Utilities

Module Dependencies

Core

click - CLI framework
rich - Terminal formatting
python-dotenv - Env loading for interactive bits
requests - HTTP client

Optional

PDF (super-pocket[pdf]): fpdf2, markdown-pdf

Web (super-pocket[web]): Pillow

Dev (super-pocket[dev]): pytest, pytest-cov, black, ruff

Import Patterns

from src.super_pocket.markdown.renderer import read_markdown_file, render_markdown
from src.super_pocket.project.to_file import create_codebase_markdown
from src.super_pocket.project.req_to_date import run_req_to_date
from src.super_pocket.readme.generator import ReadmeGenerator
from src.super_pocket.readme.detector import ProjectDetector
from src.super_pocket.web.favicon import convert_to_favicon
from src.super_pocket.xml.xml import parse_custom_syntax

# Render markdown
render_markdown(read_markdown_file("README.md"))

# Export project
create_codebase_markdown(".", "export.md", ".git,venv,node_modules")

# Audit deps
run_req_to_date(("click==8.1.7", "rich>=13"))

# Generate README content
ctx = ProjectDetector().detect(".")
content = ReadmeGenerator().generate(ctx, [], [])