python3-cyberfusion-cluster-apicli

Name	python3-cyberfusion-cluster-apicli JSON
Version	3.0 JSON
	download
home_page	https://vcs.cyberfusion.nl/core/python3-cyberfusion-cluster-apicli
Summary	API client for Cluster API.
upload_time	2023-09-27 12:00:12
maintainer
docs_url	None
author	William Edwards
requires_python	>=3.9
license	MIT
keywords	cyberfusion cluster api
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # python3-cyberfusion-cluster-apicli

API client for Cluster API.

# Install

## PyPI

Run the following command to install the package from PyPI:

    pip3 install python3-cyberfusion-cluster-apicli

## Generic

Run the following command to create a source distribution:

    python3 setup.py sdist

## Debian

Run the following commands to build a Debian package:

    mk-build-deps -i -t 'apt -o Debug::pkgProblemResolver=yes --no-install-recommends -y'
    dpkg-buildpackage -us -uc

# Configure

## Config file options

* Section `clusterapi`, key `serverurl`
* Section `clusterapi`, keys `username` and `password` (optional)
* Section `clusterapi`, key `apikey` (optional)

## Class options

* `config_file_path`. Non-default config file path.
* `authenticate`. Endpoint is called without token when set.

# Usage

## Basic

```python
from cyberfusion.ClusterApiCli import ClusterApiRequest

endpoint = "/api/v1/certificates"

r = ClusterApiRequest()
```

## Request

First, set the request:

```python
r.GET(endpoint)
r.PATCH(endpoint)
r.PUT(endpoint)
r.POST(endpoint)
r.DELETE(endpoint)
```

Then execute the request:

```
print(r.execute())
```

# Tests

Run tests with pytest:

    pytest tests/

The config file in `cyberfusion.cfg` (working directory) is used.



            

Raw data

            {
    "_id": null,
    "home_page": "https://vcs.cyberfusion.nl/core/python3-cyberfusion-cluster-apicli",
    "name": "python3-cyberfusion-cluster-apicli",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "cyberfusion,cluster,api",
    "author": "William Edwards",
    "author_email": "wedwards@cyberfusion.nl",
    "download_url": "https://files.pythonhosted.org/packages/b3/c4/9e06a11eda35e3b0b7ef40d4073c00e9ea07ead8a445428ee2c7723f9784/python3-cyberfusion-cluster-apicli-3.0.tar.gz",
    "platform": "linux",
    "description": "# python3-cyberfusion-cluster-apicli\n\nAPI client for Cluster API.\n\n# Install\n\n## PyPI\n\nRun the following command to install the package from PyPI:\n\n    pip3 install python3-cyberfusion-cluster-apicli\n\n## Generic\n\nRun the following command to create a source distribution:\n\n    python3 setup.py sdist\n\n## Debian\n\nRun the following commands to build a Debian package:\n\n    mk-build-deps -i -t 'apt -o Debug::pkgProblemResolver=yes --no-install-recommends -y'\n    dpkg-buildpackage -us -uc\n\n# Configure\n\n## Config file options\n\n* Section `clusterapi`, key `serverurl`\n* Section `clusterapi`, keys `username` and `password` (optional)\n* Section `clusterapi`, key `apikey` (optional)\n\n## Class options\n\n* `config_file_path`. Non-default config file path.\n* `authenticate`. Endpoint is called without token when set.\n\n# Usage\n\n## Basic\n\n```python\nfrom cyberfusion.ClusterApiCli import ClusterApiRequest\n\nendpoint = \"/api/v1/certificates\"\n\nr = ClusterApiRequest()\n```\n\n## Request\n\nFirst, set the request:\n\n```python\nr.GET(endpoint)\nr.PATCH(endpoint)\nr.PUT(endpoint)\nr.POST(endpoint)\nr.DELETE(endpoint)\n```\n\nThen execute the request:\n\n```\nprint(r.execute())\n```\n\n# Tests\n\nRun tests with pytest:\n\n    pytest tests/\n\nThe config file in `cyberfusion.cfg` (working directory) is used.\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "API client for Cluster API.",
    "version": "3.0",
    "project_urls": {
        "Homepage": "https://vcs.cyberfusion.nl/core/python3-cyberfusion-cluster-apicli"
    },
    "split_keywords": [
        "cyberfusion",
        "cluster",
        "api"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b3c49e06a11eda35e3b0b7ef40d4073c00e9ea07ead8a445428ee2c7723f9784",
                "md5": "a4235d7784590b2fa32d9b89d5d34320",
                "sha256": "09b1bc17b0b3b7069835e5c91dc78346bec76fb750a589f61adadeb53f4245f5"
            },
            "downloads": -1,
            "filename": "python3-cyberfusion-cluster-apicli-3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "a4235d7784590b2fa32d9b89d5d34320",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 6908,
            "upload_time": "2023-09-27T12:00:12",
            "upload_time_iso_8601": "2023-09-27T12:00:12.596550Z",
            "url": "https://files.pythonhosted.org/packages/b3/c4/9e06a11eda35e3b0b7ef40d4073c00e9ea07ead8a445428ee2c7723f9784/python3-cyberfusion-cluster-apicli-3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-27 12:00:12",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "python3-cyberfusion-cluster-apicli"
}