PyPI API Client - v1.0.0
    Preparing search index...

    Class PyPIClient

    Main entry point for the PyPI REST API client.

    import { PyPIClient } from 'pypi-api-client';

    const pip = new PyPIClient();

    // Full project metadata
    const project = await pip.package('requests');

    // Specific version
    const v = await pip.package('requests').version('2.31.0');

    // Latest version files
    const files = await pip.package('requests').latest().files();

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

    // Observe every request
    pip.on('request', event => {
      console.log(`${event.method} ${event.url} — ${event.durationMs}ms`);
    });
    Index

    Constructors

    constructor

    Methods

    on package

    Constructors

    Methods

    • Subscribes to a client event.

      Type Parameters

      • K extends "request"

      Parameters

      Returns this

      pip.on('request', (event) => {
        console.log(`${event.method} ${event.url} — ${event.durationMs}ms`);
        if (event.error) console.error('Request failed:', event.error);
      });

    • Returns a PackageResource for a given project name, providing access to project metadata, versions, distribution files, and download stats.

      The returned resource can be awaited directly to fetch the full project, or chained to access nested resources.

      Parameters

      • name: string

        The project name (e.g. 'requests', 'numpy')

      Returns PackageResource

      A chainable package resource

      const project = await pip.package('requests');
      const info    = await pip.package('requests').info();
      const v       = await pip.package('requests').version('2.31.0');
      const files   = await pip.package('requests').latest().files();

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods