enhance setup & clarify readme

Author: tdiprima

.github/workflows/ci.yml

@@ -19,6 +19,7 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - run: python -m pip install --upgrade pip
       - run: pip install build pytest
+      - run: pip install -e .
       - run: pytest
   build:
     runs-on: ubuntu-latest

.gitignore

@@ -186,7 +186,7 @@ cython_debug/
 #  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
 #  and can be added to the global gitignore or merged into this file. However, if you prefer, 
 #  you could uncomment the following to ignore the entire vscode folder
-# .vscode/
+.vscode/
 
 # Ruff stuff:
 .ruff_cache/

README.md

@@ -1,3 +1,37 @@
-# pyupgradecheck
+# 🐍 pyupgradecheck
 
-"Is there a tool for checking Python upgrade-compatibility?" — people explicitly asking for utilities to check if packages support a target Python version.
+Quickly see which of your installed packages are ready for your next Python version.
+
+### Example
+
+```bash
+$ pyupgradecheck 3.13
+requests 2.32.3: supported (PyPI requires_python: >=3.7)
+some-old-lib 1.2.0: incompatible (PyPI requires_python: <3.10)
+```
+
+### Install
+
+```bash
+pip install pyupgradecheck
+```
+
+### Use programmatically
+
+```python
+from pyupgradecheck import check_environment
+print(check_environment("3.13"))
+```
+
+### CLI help
+
+```bash
+pyupgradecheck --help
+```
+
+### Contributing
+PRs welcome 💖 — run tests with:
+
+```bash
+pytest
+```

pyupgradecheck/checker.py

@@ -6,7 +6,6 @@
 from typing import Dict, List, Optional, Tuple
 
 try:
-    # py3.8+
     from importlib import metadata as importlib_metadata
 except Exception:
     import importlib_metadata
@@ -68,7 +67,7 @@ def check_pkg_compatibility(
     req = fetch_pypi_requires_python(pkg)
     spec = parse_requires_python(req)
     if spec is not None:
-        # packaging accepts versions like '>=3.8'
+        # packaging accepts versions like '>=3.9'
         try:
             target_v = Version(target_python)
         except InvalidVersion:

pyupgradecheck/cli.py

@@ -9,9 +9,9 @@ def main():
         prog="pyupgradecheck",
         description="Check installed packages for Python version compatibility.",
     )
-    p.add_argument("target", help="Target Python version (e.g. 3.11)")
+    p.add_argument("target", help="Target Python version (e.g. 3.13)")
     p.add_argument("--packages", "-p", nargs="+", help="Specific packages to check")
-    p.add_argument("--json", action="store_true", help="Emit json")
+    p.add_argument("--json", action="store_true", help="Emit json output")
     args = p.parse_args()
     report = check_environment(args.target, args.packages)
     if args.json: