Metadata-Version: 2.4
Name: nab-index
Version: 0.0.2
Summary: PyPI Simple-API client and on-disk cache for nab
Project-URL: Homepage, https://github.com/notatallshaw/nab
Project-URL: Documentation, https://nab.readthedocs.io/
Project-URL: Issues, https://github.com/notatallshaw/nab/issues
Project-URL: Source, https://github.com/notatallshaw/nab
Project-URL: Changelog, https://github.com/notatallshaw/nab/blob/main/CHANGELOG.md
Author-email: Damian Shaw <damian.peter.shaw@gmail.com>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Typing :: Typed
Requires-Python: >=3.10
Requires-Dist: packaging>=24.0
Requires-Dist: typing-extensions>=4.6
Requires-Dist: urllib3>=2.0
Provides-Extra: httpx
Requires-Dist: httpx[http2]>=0.28; extra == 'httpx'
Provides-Extra: niquests
Requires-Dist: niquests>=3.18; extra == 'niquests'
Description-Content-Type: text/markdown

# nab-index

PyPI Simple-API client and on-disk cache used by
[`nab-python`](https://pypi.org/project/nab-python/) and
[`nab`](https://pypi.org/project/nab/).

It provides:

- A small async transport interface with three drop-in backends:
  - `urllib3` (default; pulled in by the base install).
  - `httpx` (extra: `nab-index[httpx]`).
  - `niquests` (extra: `nab-index[niquests]`).
- A Simple-API client with JSON and HTML decoders.
- A disk cache for project listings and file metadata responses.
- A multi-index router (ordered named indexes plus per-package
  overrides guarded by PEP 508 markers).
- A small VCS clone helper used by the higher-level VCS policy.

## When to use it

Use `nab-index` if you need a typed PyPI Simple-API client with an
on-disk cache.  Most users want
[`nab`](https://pypi.org/project/nab/) instead.

The API is currently under rapid experimentation, if you use it
pin to an exact version.