Skip to content

viseshrp/whatsonpypi

Repository files navigation

whatsonpypi

PyPI version Python versions CI Coverage License: MIT Code Style: Black Lint: Ruff Typing: mypy

Get package info from PyPI.

Demo

🚀 Why this project exists

I find myself checking the PyPI page very frequently mostly when upgrading dependencies to get the latest versions. I'm inherently lazy and did not want to get my ass off my terminal window.

🧠 How this project works

No real magic here. It uses the requests package to hit the public PyPI REST API, parses the JSON and displays it. Embarrassingly simple.

📐 Requirements

  • Python >= 3.9

📦 Installation

pip install whatsonpypi

OR

pip install whatsonpypi[rich]

... if you want to use the rich package for a nicer output.

🧪 Usage

$ whatsonpypi --help
Usage: whatsonpypi [OPTIONS] PACKAGE

  A CLI tool to get package info from PyPI.

  Example usages:

  $ whatsonpypi django

  OR

  $ wopp django

Options:
  -v, --version          Show the version and exit.
  -m, --more             Flag to enable expanded output
  -d, --docs             Flag to open docs or homepage of project
  -o, --open             Flag to open PyPI page
  -H, --history INTEGER  Show release history. Use positive number for most
                         recent, negative for oldest. E.g. '--history -10' or '
                         --history 10'
  -h, --help             Show this message and exit.

🛠️ Features

  • Find information on a package on PyPI

    Examples:

    $ whatsonpypi django
    NAME
        Django
       ...
  • For more information..

    Examples:

    $ whatsonpypi django --more
    ...
  • Version specific information..

    Examples:

    $ whatsonpypi django==2.1.4 --more
    ...
  • Launch PyPI URL of project in a browser tab

    Examples:

    $ whatsonpypi django --open
  • Launch documentation URL of project in a browser tab

    Examples:

    $ whatsonpypi django --docs
  • Get release info of the last 5 versions

    Examples:

    $ whatsonpypi django --history 5
  • Get release info of the first 5 versions

    Examples:

    $ whatsonpypi django --history -5

🧾 Changelog

See CHANGELOG.md

🙏 Credits

📄 License

MIT © Visesh Prasad