Class PackageResource

Represents a PyPI project, providing access to metadata, versions, distribution files, download statistics, and vulnerability data.

Implements PromiseLike<PyPIProject> so it can be awaited directly to fetch the full project, while also exposing sub-resource methods.

Example

// Await directly to get full project metadata
const project = await pip.package('requests');

// Get the info block
const info = await pip.package('requests').info();

// Get a specific version
const v = await pip.package('requests').version('2.31.0');

// Get download stats
const stats = await pip.package('requests').downloads();

Implements

PromiseLike<PyPIProject>

Index

Methods

then get info version latest versions releases vulnerabilities downloads downloadsByPythonMajor downloadsByPythonMinor downloadsBySystem downloadsByMirrors

Methods

then

then<TResult1 = PyPIProject, TResult2 = never>(
    onfulfilled?:
        | ((value: PyPIProject) => TResult1 | PromiseLike<TResult1>)
        | null,
    onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null,
): PromiseLike<TResult1 | TResult2>
Attaches callbacks for the resolution and/or rejection of the Promise.
Type Parameters
- TResult1 = PyPIProject
- TResult2 = never
Parameters
- Optionalonfulfilled: ((value: PyPIProject) => TResult1 | PromiseLike<TResult1>) | null
  The callback to execute when the Promise is resolved.
- Optionalonrejected: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null
  The callback to execute when the Promise is rejected.
Returns PromiseLike<TResult1 | TResult2>
A Promise for the completion of which ever callback is executed.
Implementation of PromiseLike.then
- Defined in src/resources/PackageResource.ts:38

get

get(signal?: AbortSignal): Promise<PyPIProject>
Fetches full project metadata including all releases.

GET /pypi/{name}/json
Parameters
- Optionalsignal: AbortSignal
  Optional AbortSignal to cancel the request
Returns Promise<PyPIProject>
- Defined in src/resources/PackageResource.ts:52

info

info(signal?: AbortSignal): Promise<PyPIProjectInfo>
Fetches only the info block for the latest version of this package.

GET /pypi/{name}/json → extracts info
Parameters
- Optionalsignal: AbortSignal
  Optional AbortSignal to cancel the request
Returns Promise<PyPIProjectInfo>
- Defined in src/resources/PackageResource.ts:68

version

version(ver: string): VersionResource
Returns a VersionResource for a specific version.
Parameters
- ver: string
  Version string (e.g. '2.31.0')
Returns VersionResource
- Defined in src/resources/PackageResource.ts:78

latest

latest(): VersionResource
Returns a VersionResource for the latest published version.

When awaited, fetches GET /pypi/{name}/json and returns the latest version data (from the info and urls fields).

Returns VersionResource
- Defined in src/resources/PackageResource.ts:88

versions

versions(signal?: AbortSignal): Promise<string[]>
Returns all version strings published for this package.

GET /pypi/{name}/json → extracts Object.keys(releases)
Parameters
- Optionalsignal: AbortSignal
  Optional AbortSignal to cancel the request
Returns Promise<string[]>
- Defined in src/resources/PackageResource.ts:99

releases

releases(signal?: AbortSignal): Promise<Record<string, PyPIFile[]>>
Returns the full releases map: version string → distribution files.

GET /pypi/{name}/json → extracts releases
Parameters
- Optionalsignal: AbortSignal
  Optional AbortSignal to cancel the request
Returns Promise<Record<string, PyPIFile[]>>
- Defined in src/resources/PackageResource.ts:111

vulnerabilities

vulnerabilities(signal?: AbortSignal): Promise<PyPIVulnerability[]>
Returns known vulnerabilities for the latest version from PyPI's advisory database.

GET /pypi/{name}/json → extracts vulnerabilities
Parameters
- Optionalsignal: AbortSignal
  Optional AbortSignal to cancel the request
Returns Promise<PyPIVulnerability[]>
- Defined in src/resources/PackageResource.ts:123

downloads

downloads(signal?: AbortSignal): Promise<PyPIRecentDownloads>
Fetches download totals for the last day, week, and month from pypistats.org.

GET /api/packages/{name}/recent (via pypistats.org)
Parameters
- Optionalsignal: AbortSignal
  Optional AbortSignal to cancel the request
Returns Promise<PyPIRecentDownloads>
Example
```
const stats = await pip.package('requests').downloads();
console.log(stats.data.last_week); // 8638
```
- Defined in src/resources/PackageResource.ts:141

downloadsByPythonMajor

downloadsByPythonMajor(
params?: PyPIDownloadParams,
signal?: AbortSignal,
): Promise<PyPIBreakdownDownloads>
Fetches per-day downloads broken down by Python major version (2 vs 3).

GET /api/packages/{name}/python_major (via pypistats.org)
Parameters
- Optionalparams: PyPIDownloadParams
  Optional start_date / end_date filters (YYYY-MM-DD)
- Optionalsignal: AbortSignal
  Optional AbortSignal to cancel the request
Returns Promise<PyPIBreakdownDownloads>
- Defined in src/resources/PackageResource.ts:158

downloadsByPythonMinor

downloadsByPythonMinor(
params?: PyPIDownloadParams,
signal?: AbortSignal,
): Promise<PyPIBreakdownDownloads>
Fetches per-day downloads broken down by Python minor version (3.10, 3.11, …).

GET /api/packages/{name}/python_minor (via pypistats.org)
Parameters
- Optionalparams: PyPIDownloadParams
  Optional start_date / end_date filters (YYYY-MM-DD)
- Optionalsignal: AbortSignal
  Optional AbortSignal to cancel the request
Returns Promise<PyPIBreakdownDownloads>
- Defined in src/resources/PackageResource.ts:178

downloadsBySystem

downloadsBySystem(
params?: PyPIDownloadParams,
signal?: AbortSignal,
): Promise<PyPIBreakdownDownloads>
Fetches per-day downloads broken down by operating system (Linux, Windows, macOS).

GET /api/packages/{name}/system (via pypistats.org)
Parameters
- Optionalparams: PyPIDownloadParams
  Optional start_date / end_date filters (YYYY-MM-DD)
- Optionalsignal: AbortSignal
  Optional AbortSignal to cancel the request
Returns Promise<PyPIBreakdownDownloads>
- Defined in src/resources/PackageResource.ts:198

downloadsByMirrors

downloadsByMirrors(
params?: PyPIDownloadParams,
signal?: AbortSignal,
): Promise<PyPIBreakdownDownloads>
Fetches per-day downloads split by mirror vs non-mirror traffic.

GET /api/packages/{name}/overall (via pypistats.org)
Parameters
- Optionalparams: PyPIDownloadParams
  Optional start_date / end_date filters (YYYY-MM-DD)
- Optionalsignal: AbortSignal
  Optional AbortSignal to cancel the request
Returns Promise<PyPIBreakdownDownloads>
- Defined in src/resources/PackageResource.ts:218

Class PackageResource

Example

Implements

Index

Methods

Methods

then

Type Parameters

Parameters

Returns PromiseLike<TResult1 | TResult2>

get

Parameters

Returns Promise<PyPIProject>

info

Parameters

Returns Promise<PyPIProjectInfo>

version

Parameters

Returns VersionResource

latest

Returns VersionResource

versions

Parameters

Returns Promise<string[]>

releases

Parameters

Returns Promise<Record<string, PyPIFile[]>>

vulnerabilities

Parameters

Returns Promise<PyPIVulnerability[]>

downloads

Parameters

Returns Promise<PyPIRecentDownloads>

Example

downloadsByPythonMajor

Parameters

Returns Promise<PyPIBreakdownDownloads>

downloadsByPythonMinor

Parameters

Returns Promise<PyPIBreakdownDownloads>

downloadsBySystem

Parameters

Returns Promise<PyPIBreakdownDownloads>

downloadsByMirrors

Parameters

Returns Promise<PyPIBreakdownDownloads>

Settings

On This Page