grepme-x 1.0.0

Generate README from project structure

grepme-x

Generate README from project structure

Version

1.0.0

Authentication

Detected:

• DRF permission classes
• FastAPI OAuth2 / Bearer token
• Flask-Login / Django login_required
• JWT decorator auth

Required auth environment variables:

AUTH0_CLIENT_ID=
AUTH0_CLIENT_SECRET=
AUTH0_DOMAIN=
COOKIE_SECRET=
FIREBASE_API_KEY=
FIREBASE_CREDENTIALS=
FIREBASE_PROJECT_ID=
GITHUB_CLIENT_ID=
GITHUB_CLIENT_SECRET=
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
JWT_PRIVATE_KEY=
JWT_PUBLIC_KEY=
JWT_SECRET=
OAUTH_CLIENT_ID=
OAUTH_CLIENT_SECRET=
SECRET_KEY=
SESSION_SECRET=
SUPABASE_ANON_KEY=
SUPABASE_SERVICE_ROLE_KEY=
SUPABASE_URL=

Routes

No routes found.

Middleware

• SomeMiddleware

Views / Controllers

• add
• build_tree
• classify_file
• detect_auth
• extract_env_vars
• extract_functions
• extract_middleware
• extract_routes
• extract_schemas
• generate_ai_readme
• generate_markdown
• get_docker_info
• get_files
• get_package_info
• main
• parse_args
• safe_read

Models & Schemas

No models found.

Environment Variables

Create a .env file:

ANTHROPIC_API_KEY=
VAR=

Dependencies

None.

Project Structure

├── grepme_x/
│   ├── __init__.py
│   └── main.py
├── grepme_x.egg-info/
│   ├── PKG-INFO
│   ├── SOURCES.txt
│   ├── dependency_links.txt
│   ├── entry_points.txt
│   └── top_level.txt
└── pyproject.toml

---

Generated by grepme-x