pulp-hugging-face-client 0.3.0

Pulp 3 API

pulp_hugging_face-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.3.0
• Generator version: 7.14.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_hugging_face

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_hugging_face

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import pulpcore.client.pulp_hugging_face
from pulpcore.client.pulp_hugging_face.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_hugging_face.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_hugging_face.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_hugging_face.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_hugging_face.ContentHuggingFaceApi(api_client)
    hugging_face_hugging_face_content = pulpcore.client.pulp_hugging_face.HuggingFaceHuggingFaceContent() # HuggingFaceHuggingFaceContent | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Create a hugging face content
        api_response = api_instance.create(hugging_face_hugging_face_content, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentHuggingFaceApi->create:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ContentHuggingFaceApi->create: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
ContentHuggingFaceApi	create	POST /pulp/api/v3/content/hugging_face/hugging-face/	Create a hugging face content
ContentHuggingFaceApi	list	GET /pulp/api/v3/content/hugging_face/hugging-face/	List hugging face contents
ContentHuggingFaceApi	read	GET {hugging_face_hugging_face_content_href}	Inspect a hugging face content
ContentHuggingFaceApi	set_label	POST {hugging_face_hugging_face_content_href}set_label/	Set a label
ContentHuggingFaceApi	unset_label	POST {hugging_face_hugging_face_content_href}unset_label/	Unset a label
DistributionsHuggingFaceApi	create	POST /pulp/api/v3/distributions/hugging_face/hugging-face/	Create a hugging face distribution
DistributionsHuggingFaceApi	delete	DELETE {hugging_face_hugging_face_distribution_href}	Delete a hugging face distribution
DistributionsHuggingFaceApi	list	GET /pulp/api/v3/distributions/hugging_face/hugging-face/	List hugging face distributions
DistributionsHuggingFaceApi	partial_update	PATCH {hugging_face_hugging_face_distribution_href}	Update a hugging face distribution
DistributionsHuggingFaceApi	read	GET {hugging_face_hugging_face_distribution_href}	Inspect a hugging face distribution
DistributionsHuggingFaceApi	set_label	POST {hugging_face_hugging_face_distribution_href}set_label/	Set a label
DistributionsHuggingFaceApi	unset_label	POST {hugging_face_hugging_face_distribution_href}unset_label/	Unset a label
DistributionsHuggingFaceApi	update	PUT {hugging_face_hugging_face_distribution_href}	Update a hugging face distribution
PublicationsHuggingFaceApi	create	POST /pulp/api/v3/publications/hugging_face/hugging-face/	Create a hugging face publication
PublicationsHuggingFaceApi	delete	DELETE {hugging_face_hugging_face_publication_href}	Delete a hugging face publication
PublicationsHuggingFaceApi	list	GET /pulp/api/v3/publications/hugging_face/hugging-face/	List hugging face publications
PublicationsHuggingFaceApi	read	GET {hugging_face_hugging_face_publication_href}	Inspect a hugging face publication
RemotesHuggingFaceApi	create	POST /pulp/api/v3/remotes/hugging_face/hugging-face/	Create a hugging face remote
RemotesHuggingFaceApi	delete	DELETE {hugging_face_hugging_face_remote_href}	Delete a hugging face remote
RemotesHuggingFaceApi	list	GET /pulp/api/v3/remotes/hugging_face/hugging-face/	List hugging face remotes
RemotesHuggingFaceApi	partial_update	PATCH {hugging_face_hugging_face_remote_href}	Update a hugging face remote
RemotesHuggingFaceApi	read	GET {hugging_face_hugging_face_remote_href}	Inspect a hugging face remote
RemotesHuggingFaceApi	set_label	POST {hugging_face_hugging_face_remote_href}set_label/	Set a label
RemotesHuggingFaceApi	unset_label	POST {hugging_face_hugging_face_remote_href}unset_label/	Unset a label
RemotesHuggingFaceApi	update	PUT {hugging_face_hugging_face_remote_href}	Update a hugging face remote
RepositoriesHuggingFaceApi	create	POST /pulp/api/v3/repositories/hugging_face/hugging-face/	Create a hugging face repository
RepositoriesHuggingFaceApi	delete	DELETE {hugging_face_hugging_face_repository_href}	Delete a hugging face repository
RepositoriesHuggingFaceApi	list	GET /pulp/api/v3/repositories/hugging_face/hugging-face/	List hugging face repositorys
RepositoriesHuggingFaceApi	modify	POST {hugging_face_hugging_face_repository_href}modify/	Modify Repository Content
RepositoriesHuggingFaceApi	partial_update	PATCH {hugging_face_hugging_face_repository_href}	Update a hugging face repository
RepositoriesHuggingFaceApi	read	GET {hugging_face_hugging_face_repository_href}	Inspect a hugging face repository
RepositoriesHuggingFaceApi	set_label	POST {hugging_face_hugging_face_repository_href}set_label/	Set a label
RepositoriesHuggingFaceApi	sync	POST {hugging_face_hugging_face_repository_href}sync/	Sync from remote
RepositoriesHuggingFaceApi	unset_label	POST {hugging_face_hugging_face_repository_href}unset_label/	Unset a label
RepositoriesHuggingFaceApi	update	PUT {hugging_face_hugging_face_repository_href}	Update a hugging face repository
RepositoriesHuggingFaceVersionsApi	delete	DELETE {hugging_face_hugging_face_repository_version_href}	Delete a repository version
RepositoriesHuggingFaceVersionsApi	list	GET {hugging_face_hugging_face_repository_href}versions/	List repository versions
RepositoriesHuggingFaceVersionsApi	read	GET {hugging_face_hugging_face_repository_version_href}	Inspect a repository version
RepositoriesHuggingFaceVersionsApi	repair	POST {hugging_face_hugging_face_repository_version_href}repair/

Documentation For Models

• AsyncOperationResponse
• ContentSummaryResponse
• HuggingFaceHuggingFaceContent
• HuggingFaceHuggingFaceContentResponse
• HuggingFaceHuggingFaceDistribution
• HuggingFaceHuggingFaceDistributionResponse
• HuggingFaceHuggingFacePublication
• HuggingFaceHuggingFacePublicationResponse
• HuggingFaceHuggingFaceRemote
• HuggingFaceHuggingFaceRemoteResponse
• HuggingFaceHuggingFaceRemoteResponseHiddenFieldsInner
• HuggingFaceHuggingFaceRepository
• HuggingFaceHuggingFaceRepositoryResponse
• PaginatedRepositoryVersionResponseList
• PaginatedhuggingFaceHuggingFaceContentResponseList
• PaginatedhuggingFaceHuggingFaceDistributionResponseList
• PaginatedhuggingFaceHuggingFacePublicationResponseList
• PaginatedhuggingFaceHuggingFaceRemoteResponseList
• PaginatedhuggingFaceHuggingFaceRepositoryResponseList
• PatchedhuggingFaceHuggingFaceDistribution
• PatchedhuggingFaceHuggingFaceRemote
• PatchedhuggingFaceHuggingFaceRepository
• PolicyEnum
• Repair
• RepoTypeEnum
• 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

[e-mail]