Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jwodder/qypi
Query PyPI from the command line
https://github.com/jwodder/qypi
available-on-pypi packages pip pypi python search warehouse
Last synced: about 2 months ago
JSON representation
Query PyPI from the command line
- Host: GitHub
- URL: https://github.com/jwodder/qypi
- Owner: jwodder
- License: mit
- Created: 2017-03-28T01:44:27.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-05-02T02:23:10.000Z (8 months ago)
- Last Synced: 2024-09-15T23:51:47.996Z (3 months ago)
- Topics: available-on-pypi, packages, pip, pypi, python, search, warehouse
- Language: Python
- Size: 156 KB
- Stars: 13
- Watchers: 4
- Forks: 3
- Open Issues: 9
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
|repostatus| |ci-status| |coverage| |pyversions| |license|
.. |repostatus| image:: https://www.repostatus.org/badges/latest/active.svg
:target: https://www.repostatus.org/#active
:alt: Project Status: Active — The project has reached a stable, usable
state and is being actively developed.
.. |ci-status| image:: https://github.com/jwodder/qypi/actions/workflows/test.yml/badge.svg
:target: https://github.com/jwodder/qypi/actions/workflows/test.yml
:alt: CI Status
.. |coverage| image:: https://codecov.io/gh/jwodder/qypi/branch/master/graph/badge.svg
:target: https://codecov.io/gh/jwodder/qypi
.. |pyversions| image:: https://img.shields.io/pypi/pyversions/qypi.svg
:target: https://pypi.org/project/qypi/
.. |license| image:: https://img.shields.io/github/license/jwodder/qypi.svg?maxAge=2592000
:target: https://opensource.org/licenses/MIT
:alt: MIT License
`GitHub `_
| `PyPI `_
| `Issues `_
| `Changelog `_
``qypi`` is a command-line client for querying & searching `the Python Package
Index `_ for Python package information and outputting JSON
(with some minor opinionated changes to the output data structures; see the
examples below).
Installation
============
``qypi`` requires Python 3.6 or higher. Just use version 6.0 or higher of `pip
`_ for Python 3 (You have pip, right?) to install ``qypi``
and its dependencies::
python3 -m pip install qypi
Usage
=====
::
qypi [-i|--index-url ] [] []
Global Option
-------------
-i URL, --index-url URL
Query the Python package server at the given URL, which
must support both the XML-RPC_ and JSON_ APIs. By
default, ``qypi`` queries `PyPI (Warehouse)
`_ at ``https://pypi.org/pypi``.
.. _XML-RPC: https://warehouse.readthedocs.io/api-reference/xml-rpc/
.. _JSON: https://warehouse.readthedocs.io/api-reference/json/
List Packages
-------------
``list``
^^^^^^^^
::
qypi list
List all packages registered on PyPI, one per line, in the order that they are
returned by the API. ``list`` and ``readme`` are the only subcommands that do
not output JSON.
``search``
^^^^^^^^^^
::
qypi search [--and|--or] [--packages|--releases] ...
Search PyPI for packages or package releases matching the given search terms.
Search terms consist of a field name and a value separated by a colon; a term
without a colon searches the ``description`` field. As documented `here
`_, the supported
searchable fields are:
- ``name``
- ``version``
- ``author``
- ``author_email``
- ``maintainer``
- ``maintainer_email``
- ``home_page`` (aliases: ``homepage`` and ``url``)
- ``license``
- ``summary``
- ``description`` (aliases: ``long_description`` and ``readme``)
- ``keywords`` (alias: ``keyword``)
- ``platform``
- ``download_url``
All other fields are ignored.
Multiple search terms referring to the same field are combined with logical OR.
Search terms on different fields are combined according to whether ``--and`` or
``--or`` is specified on the command line; the default behavior is ``--and``.
By default, ``search`` lists every matching release for every package, even if
the same package has multiple matching releases. To list no more than one
release (specifically, the highest-versioned) per package, specify the
``-p``/``--packages`` option on the command line. ``-r``/``--releases``
restores the default behavior.
``browse``
^^^^^^^^^^
::
qypi browse [-f|--file ] [--packages|--releases] ...
List packages or package releases with the given `trove classifiers
`_. Because trove
classifiers are not the most command-line friendly thing in the world, they may
optionally be read from a file, one classifier per line. Any further
classifiers listed on the command line will be added to the file's list.
By default, ``browse`` lists every matching release for every package, even if
the same package has multiple matching releases. To list no more than one
release (specifically, the highest-versioned) per package, specify the
``-p``/``--packages`` option on the command line. ``-r``/``--releases``
restores the default behavior.
``owned``
^^^^^^^^^
::
qypi owned ...
List packages owned or maintained by the given PyPI users
Package Information
-------------------
``releases``
^^^^^^^^^^^^
::
qypi releases ...
List the released versions for the given packages in PEP 440 order
Example::
$ qypi releases qypi
{
"qypi": [
{
"is_prerelease": false,
"release_date": "2017-04-02T03:07:42",
"release_url": "https://pypi.org/project/qypi/0.1.0",
"version": "0.1.0"
},
{
"is_prerelease": false,
"release_date": "2017-04-02T03:32:44",
"release_url": "https://pypi.org/project/qypi/0.1.0.post1",
"version": "0.1.0.post1"
}
]
}
A release's release date is the time at which its first file was uploaded. If
there are no files associated with a release, its release date will be
``null``.
``owner``
^^^^^^^^^
::
qypi owner ...
List the PyPI users that own and/or maintain the given packages
Example::
$ qypi owner requests
{
"requests": [
{
"role": "Owner",
"user": "graffatcolmingov"
},
{
"role": "Owner",
"user": "kennethreitz"
},
{
"role": "Owner",
"user": "Lukasa"
},
{
"role": "Maintainer",
"user": "graffatcolmingov"
},
{
"role": "Maintainer",
"user": "Lukasa"
},
{
"role": "Maintainer",
"user": "nateprewitt"
}
]
}
Release Information
-------------------
These subcommands show information about individual package releases/versions
and share the same command-line options and argument syntax.
Arguments of the form ``package==version`` (e.g., ``qypi info qypi==0.1.0``)
always refer to the given version of the given package.
Arguments that are just a package name refer to (by default) the
highest-numbered non-prerelease version of the package. This can be changed
with the following options:
-A, --all-versions Show information for all versions of each package (in
PEP 440 order, excluding prereleases unless ``--pre``
is given)
--latest-version Show information for only the latest version of each
package; this is the default
--newest Define "latest version" to mean the most recently
released version. Release dates are based on file
upload times; releases without file uploads are thus
ignored.
--highest Define "latest version" to mean the highest-numbered
version; this is the default.
--pre Include prerelease & development versions
--no-pre Don't include prerelease & development versions; this
is the default.
``info``
^^^^^^^^
::
qypi info [] [--description] [--trust-downloads] ...
Show basic information about the given package releases.
By default, (long) descriptions are omitted because they can be *very* long,
and it is recommended that you view them with the ``readme`` subcommand
instead; use the ``--description`` option to include them anyway.
By default, download counts are omitted because `the feature is currently
broken & unreliable `_; use the
``--trust-downloads`` option if you want to see the values anyway.
Example::
$ qypi info qypi
[
{
"bugtrack_url": null,
"classifiers": [
"Development Status :: 4 - Beta",
"Environment :: Console",
"Intended Audience :: Developers",
"Intended Audience :: Information Technology",
"License :: OSI Approved :: MIT License",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.4",
"Programming Language :: Python :: 3.5",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3 :: Only",
"Topic :: Software Development :: Libraries :: Python Modules",
"Topic :: System :: Software Distribution"
],
"docs_url": null,
"download_url": null,
"keywords": "pypi warehouse search packages pip",
"license": "MIT",
"name": "qypi",
"people": [
{
"email": "[email protected]",
"name": "John Thorvald Wodder II",
"role": "author"
}
],
"platform": null,
"project_url": "https://pypi.org/project/qypi/",
"release_date": "2017-04-02T03:32:44",
"release_url": "https://pypi.org/project/qypi/0.1.0.post1/",
"requires_python": "~=3.4",
"summary": "Query PyPI from the command line",
"url": "https://github.com/jwodder/qypi",
"version": "0.1.0.post1"
}
]
``readme``
^^^^^^^^^^
::
qypi readme [] ...
Display the given package releases' (long) descriptions in a pager one at a
time. ``list`` and ``readme`` are the only subcommands that do not output
JSON.
``files``
^^^^^^^^^
::
qypi files [] [--trust-downloads] ...
List files available for download for the given package releases. Download
counts are omitted because `the feature is currently broken & unreliable
`_; use the
``--trust-downloads`` option if you want to see the values anyway.
Example::
$ qypi files qypi
[
{
"files": [
{
"comment_text": "",
"digests": {
"md5": "58863d77e19bf4aa1ae85026cc1ff0f6",
"sha256": "5946a4557550479af90278e5418cd2c32a2626936075078a4c7096be52d43078"
},
"filename": "qypi-0.1.0.post1-py3-none-any.whl",
"has_sig": true,
"md5_digest": "58863d77e19bf4aa1ae85026cc1ff0f6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"size": 13590,
"upload_time": "2017-04-02T03:32:44",
"url": "https://files.pythonhosted.org/packages/f9/3f/6b184713e79da15cd451f0dab91864633175242f4d321df0cacdd2dc8300/qypi-0.1.0.post1-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "bfd357b3df2c2f1cbb6d23ff7c61fbb9",
"sha256": "c99eea315455cf9fde722599ab67eeefdff5c184bb3861a7fd82f8a9387c252d"
},
"filename": "qypi-0.1.0.post1.tar.gz",
"has_sig": true,
"md5_digest": "bfd357b3df2c2f1cbb6d23ff7c61fbb9",
"packagetype": "sdist",
"python_version": "source",
"size": 8975,
"upload_time": "2017-04-02T03:32:46",
"url": "https://files.pythonhosted.org/packages/0e/49/3056ee68b44c8eab4d4698b52ae4d18c0db92c80abc312894c02c4722621/qypi-0.1.0.post1.tar.gz"
}
],
"name": "qypi",
"version": "0.1.0.post1"
}
]