pulp_npm-client

Fetch, Upload, Organize, and Distribute Software Packages

This Python package is automatically generated by the OpenAPI Generator project:

• API version: v3
• Package version: 0.10.2
• Generator version: 7.19.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://pulpproject.org

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import pulpcore.client.pulp_npm

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import pulpcore.client.pulp_npm

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:24817
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
    host = "http://localhost:24817"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'


# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_npm.ContentPackagesApi(api_client)
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    repository = 'repository_example' # str | A URI of a repository the new content unit should be associated with. (optional)
    overwrite = True # bool | When set to true, existing content in the repository with the same unique key will be silently overwritten. When set to false, the task will fail if content would be overwritten. Only used when 'repository' is specified. Defaults to true. (optional)
    pulp_labels = None # Dict[str, Optional[str]] | A dictionary of arbitrary key/value pairs used to describe a specific Content instance. (optional)
    artifact = 'artifact_example' # str | Artifact file representing the physical content (optional)
    relative_path = 'relative_path_example' # str | Path where the artifact is located relative to distributions base_path. If not provided, it will be computed from name and version. (optional)
    file = None # bytearray | An uploaded file that may be turned into the content unit. (optional)
    upload = 'upload_example' # str | An uncommitted upload that may be turned into the content unit. (optional)
    file_url = 'file_url_example' # str | A url that Pulp can download and turn into the content unit. (optional)
    downloader_config = pulpcore.client.pulp_npm.RemoteNetworkConfig() # RemoteNetworkConfig | Configuration for the download process (e.g., proxies, auth, timeouts). Only applicable when providing a 'file_url. (optional)
    name = 'name_example' # str | The name of the npm package. (optional)
    version = 'version_example' # str | The version of the npm package. (optional)

    try:
        # Create a package
        api_response = api_instance.create(x_task_diagnostics=x_task_diagnostics, repository=repository, overwrite=overwrite, pulp_labels=pulp_labels, artifact=artifact, relative_path=relative_path, file=file, upload=upload, file_url=file_url, downloader_config=downloader_config, name=name, version=version)
        print("The response of ContentPackagesApi->create:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ContentPackagesApi->create: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost:24817

Documentation For Models

• AsyncOperationResponse
• ContentSummaryResponse
• MyPermissionsResponse
• NestedRole
• NestedRoleResponse
• NpmNpmDistribution
• NpmNpmDistributionResponse
• NpmNpmRemote
• NpmNpmRemoteResponse
• NpmNpmRemoteResponseHiddenFieldsInner
• NpmNpmRepository
• NpmNpmRepositoryResponse
• NpmPackageResponse
• ObjectRolesResponse
• PaginatedRepositoryVersionResponseList
• PaginatednpmNpmDistributionResponseList
• PaginatednpmNpmRemoteResponseList
• PaginatednpmNpmRepositoryResponseList
• PaginatednpmPackageResponseList
• PatchednpmNpmDistribution
• PatchednpmNpmRemote
• PatchednpmNpmRepository
• PolicyEnum
• RemoteNetworkConfig
• RemoteNetworkConfigResponse
• Repair
• RepositoryAddRemoveContent
• RepositorySyncURL
• RepositoryVersionResponse
• SetLabel
• SetLabelResponse
• UnsetLabel
• UnsetLabelResponse

Documentation For Authorization

Authentication schemes defined for the API:

basicAuth

• Type: HTTP basic authentication

cookieAuth

• Type: API key
• API key parameter name: sessionid
• Location:

Author

pulp-list@redhat.com