Class VersionResource

Represents a specific version of a PyPI package.

Implements PromiseLike<PyPIVersionInfo> so it can be awaited directly.

Example

// Await directly to get version metadata
const info = await pip.package('requests').version('2.31.0');

// Or call .get() explicitly
const info = await pip.package('requests').version('2.31.0').get();

// Get distribution files
const files = await pip.package('requests').version('2.31.0').files();

Implements

PromiseLike<PyPIVersionInfo>

Index

Methods

then get files vulnerabilities dependencies

Methods

then

then<TResult1 = PyPIVersionInfo, TResult2 = never>(
    onfulfilled?:
        | ((value: PyPIVersionInfo) => 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 = PyPIVersionInfo
- TResult2 = never
Parameters
- Optionalonfulfilled: ((value: PyPIVersionInfo) => 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/VersionResource.ts:33

get

get(signal?: AbortSignal): Promise<PyPIVersionInfo>
Fetches metadata for this version.

When created via latest(), fetches GET /pypi/{name}/json and returns the latest version data. Otherwise fetches GET /pypi/{name}/{version}/json.
Parameters
- Optionalsignal: AbortSignal
  Optional AbortSignal to cancel the request
Returns Promise<PyPIVersionInfo>
- Defined in src/resources/VersionResource.ts:48

files

files(signal?: AbortSignal): Promise<PyPIFile[]>
Returns the distribution files (wheels, sdists) for this version.

GET /pypi/{name}/{version}/json → extracts urls
Parameters
- Optionalsignal: AbortSignal
  Optional AbortSignal to cancel the request
Returns Promise<PyPIFile[]>
- Defined in src/resources/VersionResource.ts:72

vulnerabilities

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

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

dependencies

dependencies(signal?: AbortSignal): Promise<PyPIDepsDevDependencies>
Returns the fully resolved dependency graph for this version from deps.dev.

Unlike requires_dist semver ranges, this returns exact resolved versions for every direct and transitive dependency.

GET /systems/pypi/packages/{name}/versions/{version}:dependencies (via api.deps.dev/v3)

When called on latest(), first fetches the project to determine the current version.
Parameters
- Optionalsignal: AbortSignal
  Optional AbortSignal to cancel the request
Returns Promise<PyPIDepsDevDependencies>
Example
```
const deps = await pip.package('requests').version('2.31.0').dependencies();
const direct = deps.nodes.filter(n => n.relation === 'DIRECT');
```
- Defined in src/resources/VersionResource.ts:107

Class VersionResource

Example

Implements

Index

Methods

Methods

then

Type Parameters

Parameters

Returns PromiseLike<TResult1 | TResult2>

get

Parameters

Returns Promise<PyPIVersionInfo>

files

Parameters

Returns Promise<PyPIFile[]>

vulnerabilities

Parameters

Returns Promise<PyPIVulnerability[]>

dependencies

Parameters

Returns Promise<PyPIDepsDevDependencies>

Example

Settings

On This Page