Skip to main content

Generate README from project structure

Project description

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]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

grepme_x-1.0.1.tar.gz (12.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

grepme_x-1.0.1-py3-none-any.whl (12.3 kB view details)

Uploaded Python 3

File details

Details for the file grepme_x-1.0.1.tar.gz.

File metadata

  • Download URL: grepme_x-1.0.1.tar.gz
  • Upload date:
  • Size: 12.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for grepme_x-1.0.1.tar.gz
Algorithm Hash digest
SHA256 52d5d9edae9e49b2d0703c29cceb58e7c1feb937594ae3e59254ce26e659a873
MD5 f28fe13089df47ebe90097397d551573
BLAKE2b-256 42b1d2baf5dad4520124d6668915c70c4a528318a1c447bfa529707597fb8cbc

See more details on using hashes here.

File details

Details for the file grepme_x-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: grepme_x-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 12.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for grepme_x-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cf1fcb0157e190cb5a4cb4ecd6d0670ccda8490dd12175019146bc4aa19c95a8
MD5 40a149bcfdc6f47897def70b846eacb9
BLAKE2b-256 3fbc5606c931bb400e00c8f161b96073f9e2167ef8fb5d68cecfefa703132da6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page