Skip to content

Update README install & status for the live PyPI release #5

Description

@abhiksark

Part of the 0.3.0 adoption roadmap — Discovery.

Why (adoption impact)

python-learnings is live on PyPI (0.2.0), but the README still tells people PyPI "will become the primary install path after publishing is enabled" and points them at a GitHub @v0.1.0 install. New users following the README get the wrong, harder path — an active adoption blocker.

Current state

  • Readme.md "Install" section (~lines 51–73): recommends pipx install "git+https://github.com/abhiksark/pylings.git@v0.1.0" and says PyPI is "after publishing is enabled".
  • Readme.md intro status line (~line 21): Status: v0.1.0 alpha. GitHub installs are available now; the PyPI package name is python-learnings and will become the primary install path after publishing is enabled.

Scope / acceptance criteria

  • Install section leads with PyPI: pip install python-learnings and pipx install python-learnings.
  • Documents the zero-install run (uvx --from python-learnings pylings) and uv tool install python-learnings.
  • Keeps the existing note that the command is pylings and the PyPI name is python-learnings (do NOT pip install pylings).
  • Adds a one-line "needs Python 3.9+" with links to python.org per-OS.
  • Updates the status line to v0.2.0 and removes all "after publishing" wording.
  • Keeps the GitHub/dev-build install as a secondary "latest from main" note.

Where to look

  • Readme.md — "Install", "Quick Start", and the intro status paragraph.

Out of scope

  • Badge fixes (separate issue) and the no-arg launch change (separate issue).

Verify

  • Copy each documented command into a clean shell / fresh venv on Python 3.9+ and confirm pylings --version prints 0.2.0.

Difficulty

good first issue · documentation — docs only, ~30 min.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or requestgood first issueGood for newcomers

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions