pulp-certguard-client


Namepulp-certguard-client JSON
Version 3.88.0 PyPI version JSON
download
home_pageNone
SummaryPulp 3 API
upload_time2025-09-03 10:21:00
maintainerNone
docs_urlNone
authorPulp Team
requires_python>=3.9
licenseGPL-2.0-or-later
keywords openapi openapi-generator pulp 3 api
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # pulp_certguard-client
Fetch, Upload, Organize, and Distribute Software Packages

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: v3
- Package version: 3.88.0
- Generator version: 7.14.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://pulpproject.org](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:

```sh
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:
```python
import pulpcore.client.pulp_certguard
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import pulpcore.client.pulp_certguard
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

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

    try:
        # Create a rhsm cert guard
        api_response = api_instance.create(certguard_rhsm_cert_guard, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentguardsRhsmApi->create:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ContentguardsRhsmApi->create: %s\n" % e)

```

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ContentguardsRhsmApi* | [**create**](docs/ContentguardsRhsmApi.md#create) | **POST** /pulp/api/v3/contentguards/certguard/rhsm/ | Create a rhsm cert guard
*ContentguardsRhsmApi* | [**delete**](docs/ContentguardsRhsmApi.md#delete) | **DELETE** {certguard_r_h_s_m_cert_guard_href} | Delete a rhsm cert guard
*ContentguardsRhsmApi* | [**list**](docs/ContentguardsRhsmApi.md#list) | **GET** /pulp/api/v3/contentguards/certguard/rhsm/ | List rhsm cert guards
*ContentguardsRhsmApi* | [**partial_update**](docs/ContentguardsRhsmApi.md#partial_update) | **PATCH** {certguard_r_h_s_m_cert_guard_href} | Update a rhsm cert guard
*ContentguardsRhsmApi* | [**read**](docs/ContentguardsRhsmApi.md#read) | **GET** {certguard_r_h_s_m_cert_guard_href} | Inspect a rhsm cert guard
*ContentguardsRhsmApi* | [**update**](docs/ContentguardsRhsmApi.md#update) | **PUT** {certguard_r_h_s_m_cert_guard_href} | Update a rhsm cert guard
*ContentguardsX509Api* | [**create**](docs/ContentguardsX509Api.md#create) | **POST** /pulp/api/v3/contentguards/certguard/x509/ | Create a x509 cert guard
*ContentguardsX509Api* | [**delete**](docs/ContentguardsX509Api.md#delete) | **DELETE** {certguard_x509_cert_guard_href} | Delete a x509 cert guard
*ContentguardsX509Api* | [**list**](docs/ContentguardsX509Api.md#list) | **GET** /pulp/api/v3/contentguards/certguard/x509/ | List x509 cert guards
*ContentguardsX509Api* | [**partial_update**](docs/ContentguardsX509Api.md#partial_update) | **PATCH** {certguard_x509_cert_guard_href} | Update a x509 cert guard
*ContentguardsX509Api* | [**read**](docs/ContentguardsX509Api.md#read) | **GET** {certguard_x509_cert_guard_href} | Inspect a x509 cert guard
*ContentguardsX509Api* | [**update**](docs/ContentguardsX509Api.md#update) | **PUT** {certguard_x509_cert_guard_href} | Update a x509 cert guard


## Documentation For Models

 - [CertguardRHSMCertGuard](docs/CertguardRHSMCertGuard.md)
 - [CertguardRHSMCertGuardResponse](docs/CertguardRHSMCertGuardResponse.md)
 - [CertguardX509CertGuard](docs/CertguardX509CertGuard.md)
 - [CertguardX509CertGuardResponse](docs/CertguardX509CertGuardResponse.md)
 - [PaginatedcertguardRHSMCertGuardResponseList](docs/PaginatedcertguardRHSMCertGuardResponseList.md)
 - [PaginatedcertguardX509CertGuardResponseList](docs/PaginatedcertguardX509CertGuardResponseList.md)
 - [PatchedcertguardRHSMCertGuard](docs/PatchedcertguardRHSMCertGuard.md)
 - [PatchedcertguardX509CertGuard](docs/PatchedcertguardX509CertGuard.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="basicAuth"></a>
### basicAuth

- **Type**: HTTP basic authentication

<a id="cookieAuth"></a>
### cookieAuth

- **Type**: API key
- **API key parameter name**: sessionid
- **Location**: 


## Author

pulp-list@redhat.com



            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pulp-certguard-client",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "OpenAPI, OpenAPI-Generator, Pulp 3 API",
    "author": "Pulp Team",
    "author_email": "Pulp Team <pulp-list@redhat.com>",
    "download_url": "https://files.pythonhosted.org/packages/9d/2a/967e9fcfc24e3d5b9c98c00180381740e4e266bd95055c0fc971caf45ee9/pulp_certguard-client-3.88.0.tar.gz",
    "platform": null,
    "description": "# pulp_certguard-client\nFetch, Upload, Organize, and Distribute Software Packages\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: v3\n- Package version: 3.88.0\n- Generator version: 7.14.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\nFor more information, please visit [https://pulpproject.org](https://pulpproject.org)\n\n## Requirements.\n\nPython 3.9+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport pulpcore.client.pulp_certguard\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport pulpcore.client.pulp_certguard\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport pulpcore.client.pulp_certguard\nfrom pulpcore.client.pulp_certguard.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to http://localhost:24817\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_certguard.Configuration(\n    host = \"http://localhost:24817\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_certguard.Configuration(\n    username = os.environ[\"USERNAME\"],\n    password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_certguard.ApiClient(configuration) as api_client:\n    # Create an instance of the API class\n    api_instance = pulpcore.client.pulp_certguard.ContentguardsRhsmApi(api_client)\n    certguard_rhsm_cert_guard = pulpcore.client.pulp_certguard.CertguardRHSMCertGuard() # CertguardRHSMCertGuard | \n    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n\n    try:\n        # Create a rhsm cert guard\n        api_response = api_instance.create(certguard_rhsm_cert_guard, x_task_diagnostics=x_task_diagnostics)\n        print(\"The response of ContentguardsRhsmApi->create:\\n\")\n        pprint(api_response)\n    except ApiException as e:\n        print(\"Exception when calling ContentguardsRhsmApi->create: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost:24817*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*ContentguardsRhsmApi* | [**create**](docs/ContentguardsRhsmApi.md#create) | **POST** /pulp/api/v3/contentguards/certguard/rhsm/ | Create a rhsm cert guard\n*ContentguardsRhsmApi* | [**delete**](docs/ContentguardsRhsmApi.md#delete) | **DELETE** {certguard_r_h_s_m_cert_guard_href} | Delete a rhsm cert guard\n*ContentguardsRhsmApi* | [**list**](docs/ContentguardsRhsmApi.md#list) | **GET** /pulp/api/v3/contentguards/certguard/rhsm/ | List rhsm cert guards\n*ContentguardsRhsmApi* | [**partial_update**](docs/ContentguardsRhsmApi.md#partial_update) | **PATCH** {certguard_r_h_s_m_cert_guard_href} | Update a rhsm cert guard\n*ContentguardsRhsmApi* | [**read**](docs/ContentguardsRhsmApi.md#read) | **GET** {certguard_r_h_s_m_cert_guard_href} | Inspect a rhsm cert guard\n*ContentguardsRhsmApi* | [**update**](docs/ContentguardsRhsmApi.md#update) | **PUT** {certguard_r_h_s_m_cert_guard_href} | Update a rhsm cert guard\n*ContentguardsX509Api* | [**create**](docs/ContentguardsX509Api.md#create) | **POST** /pulp/api/v3/contentguards/certguard/x509/ | Create a x509 cert guard\n*ContentguardsX509Api* | [**delete**](docs/ContentguardsX509Api.md#delete) | **DELETE** {certguard_x509_cert_guard_href} | Delete a x509 cert guard\n*ContentguardsX509Api* | [**list**](docs/ContentguardsX509Api.md#list) | **GET** /pulp/api/v3/contentguards/certguard/x509/ | List x509 cert guards\n*ContentguardsX509Api* | [**partial_update**](docs/ContentguardsX509Api.md#partial_update) | **PATCH** {certguard_x509_cert_guard_href} | Update a x509 cert guard\n*ContentguardsX509Api* | [**read**](docs/ContentguardsX509Api.md#read) | **GET** {certguard_x509_cert_guard_href} | Inspect a x509 cert guard\n*ContentguardsX509Api* | [**update**](docs/ContentguardsX509Api.md#update) | **PUT** {certguard_x509_cert_guard_href} | Update a x509 cert guard\n\n\n## Documentation For Models\n\n - [CertguardRHSMCertGuard](docs/CertguardRHSMCertGuard.md)\n - [CertguardRHSMCertGuardResponse](docs/CertguardRHSMCertGuardResponse.md)\n - [CertguardX509CertGuard](docs/CertguardX509CertGuard.md)\n - [CertguardX509CertGuardResponse](docs/CertguardX509CertGuardResponse.md)\n - [PaginatedcertguardRHSMCertGuardResponseList](docs/PaginatedcertguardRHSMCertGuardResponseList.md)\n - [PaginatedcertguardX509CertGuardResponseList](docs/PaginatedcertguardX509CertGuardResponseList.md)\n - [PatchedcertguardRHSMCertGuard](docs/PatchedcertguardRHSMCertGuard.md)\n - [PatchedcertguardX509CertGuard](docs/PatchedcertguardX509CertGuard.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n<a id=\"basicAuth\"></a>\n### basicAuth\n\n- **Type**: HTTP basic authentication\n\n<a id=\"cookieAuth\"></a>\n### cookieAuth\n\n- **Type**: API key\n- **API key parameter name**: sessionid\n- **Location**: \n\n\n## Author\n\npulp-list@redhat.com\n\n\n",
    "bugtrack_url": null,
    "license": "GPL-2.0-or-later",
    "summary": "Pulp 3 API",
    "version": "3.88.0",
    "project_urls": {
        "Repository": "https://github.com/GIT_USER_ID/GIT_REPO_ID"
    },
    "split_keywords": [
        "openapi",
        " openapi-generator",
        " pulp 3 api"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "27a269580ac9f0e6826c96fdd63bd3eb86f8e86a2c9f5218cd63f1b404fff120",
                "md5": "2e478ae00e2806316200a5285ea38d44",
                "sha256": "0d5e95c01ebd918e969306a93aaee7f9032efbd01f0ee822f07e9355379a7678"
            },
            "downloads": -1,
            "filename": "pulp_certguard_client-3.88.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2e478ae00e2806316200a5285ea38d44",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 45866,
            "upload_time": "2025-09-03T10:20:55",
            "upload_time_iso_8601": "2025-09-03T10:20:55.626857Z",
            "url": "https://files.pythonhosted.org/packages/27/a2/69580ac9f0e6826c96fdd63bd3eb86f8e86a2c9f5218cd63f1b404fff120/pulp_certguard_client-3.88.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "9d2a967e9fcfc24e3d5b9c98c00180381740e4e266bd95055c0fc971caf45ee9",
                "md5": "4da16eb178224f7b46972d25397254c0",
                "sha256": "5b918090195cac4ccdbf6f1d3629fa5d9779b20b135fefc7866d31c8286e90a7"
            },
            "downloads": -1,
            "filename": "pulp_certguard-client-3.88.0.tar.gz",
            "has_sig": false,
            "md5_digest": "4da16eb178224f7b46972d25397254c0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 31535,
            "upload_time": "2025-09-03T10:21:00",
            "upload_time_iso_8601": "2025-09-03T10:21:00.802063Z",
            "url": "https://files.pythonhosted.org/packages/9d/2a/967e9fcfc24e3d5b9c98c00180381740e4e266bd95055c0fc971caf45ee9/pulp_certguard-client-3.88.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-09-03 10:21:00",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "GIT_USER_ID",
    "github_project": "GIT_REPO_ID",
    "github_not_found": true,
    "lcname": "pulp-certguard-client"
}
        
Elapsed time: 0.82122s