Skip to content

docs: overhaul create-awesome-python-app README to CNA parity #221

Description

@ulises-jeremias

Summary

Rewrite packages/create-awesome-python-app/README.md to match the depth and structure of create-awesome-node-app package README.

Current package README is a short stub (banner + install + completion). PyPI uses this file as the long description.

Acceptance

  • Hero + badges (PyPI, Docker, AUR, Homebrew, CI, smoke)
  • Install channels: uvx, pipx, Homebrew, AUR, Docker
  • Why CPA / composition model / template & addon families
  • Popular recipes (FastAPI, Django, Celery, CLI, uv workspace, custom URL, file://, --extend, --set)
  • Interactive wizard steps, CLI reference, cache subcommand, cache/refresh/pin docs
  • Website + catalog links (create-awesome-python-app.vercel.app)
  • FAQ, contributing, license
  • Point root README users at the package README (CNA monorepo pattern)
  • Ship in a new PyPI release so the long description updates

Reference

https://github.com/Create-Node-App/create-node-app/blob/main/packages/create-awesome-node-app/README.md

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions