.. currentmodule:: pypi_simple

API
===

Client
------
.. autoclass:: PyPISimple

Core Classes
------------
.. autoclass:: IndexPage()
.. autoclass:: ProjectPage()
.. autoclass:: DistributionPackage()

Progress Trackers
-----------------
.. autoclass:: ProgressTracker()
    :special-members: __enter__, __exit__
.. autofunction:: tqdm_progress_factory

Parsing Filenames
-----------------
.. autofunction:: parse_filename

Parsing Simple Repository HTML Pages
------------------------------------
.. autoclass:: RepositoryPage()
.. autoclass:: Link()

Streaming Parsers
^^^^^^^^^^^^^^^^^
.. autofunction:: parse_links_stream
.. autofunction:: parse_links_stream_response

Constants
---------
.. autodata:: PYPI_SIMPLE_ENDPOINT
.. autodata:: SUPPORTED_REPOSITORY_VERSION

:mailheader:`Accept` Header Values
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The following constants can be passed as the ``accept`` parameter of
`PyPISimple` and some of its methods in order to indicate to the server which
serialization format of the Simple API it should return:

.. autodata:: ACCEPT_ANY
.. autodata:: ACCEPT_JSON_ONLY
.. autodata:: ACCEPT_HTML_ONLY
.. autodata:: ACCEPT_JSON_PREFERRED
.. autodata:: ACCEPT_HTML_PREFERRED

Exceptions
----------
.. autoexception:: DigestMismatchError()
    :show-inheritance:
.. autoexception:: NoDigestsError()
    :show-inheritance:
.. autoexception:: NoMetadataError()
.. autoexception:: NoProvenanceError()
.. autoexception:: NoSuchProjectError()
.. autoexception:: UnsupportedContentTypeError()
    :show-inheritance:
.. autoexception:: UnsupportedRepoVersionError()
.. autoexception:: UnexpectedRepoVersionWarning()
    :show-inheritance:
.. autoexception:: UnparsableFilenameError()
    :show-inheritance:

Footnotes
---------

.. [#pep700] The ``versions``, ``size``, and ``upload_time`` fields are only
   populated if the response was JSON from a server supporting :pep:`700`.