python3-cyberfusion-cluster-apicli

Name	python3-cyberfusion-cluster-apicli JSON
Version	3.1 JSON
	download
home_page	None
Summary	API client for Core API.
upload_time	2024-10-29 17:42:10
maintainer	None
docs_url	None
author	None
requires_python	None
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # python3-cyberfusion-cluster-apicli

API client for Core API.

# Install

## PyPI

Run the following command to install the package from PyPI:

    pip3 install python3-cyberfusion-cluster-apicli

## 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())
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "python3-cyberfusion-cluster-apicli",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "Cyberfusion <support@cyberfusion.io>",
    "download_url": "https://files.pythonhosted.org/packages/11/59/515b0ee5f79c3f64f404463ee0299b608afd1f83b9ffcaf42edb5f7bb738/python3_cyberfusion_cluster_apicli-3.1.tar.gz",
    "platform": null,
    "description": "# python3-cyberfusion-cluster-apicli\n\nAPI client for Core 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## 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",
    "bugtrack_url": null,
    "license": null,
    "summary": "API client for Core API.",
    "version": "3.1",
    "project_urls": {
        "Source": "https://vcs.cyberfusion.nl/core/python3-cyberfusion-cluster-apicli"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4da180191e5288fabd73f5d4cd210dcc6dbfc0b3521a9b7fdfb14102aeb06300",
                "md5": "e64695a84eec4fb6e83415301fa44812",
                "sha256": "49adcc06138235cf37d3e52ff93d090d789add6e649a4cdfbba7932df0d727b8"
            },
            "downloads": -1,
            "filename": "python3_cyberfusion_cluster_apicli-3.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e64695a84eec4fb6e83415301fa44812",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 7111,
            "upload_time": "2024-10-29T17:42:09",
            "upload_time_iso_8601": "2024-10-29T17:42:09.094537Z",
            "url": "https://files.pythonhosted.org/packages/4d/a1/80191e5288fabd73f5d4cd210dcc6dbfc0b3521a9b7fdfb14102aeb06300/python3_cyberfusion_cluster_apicli-3.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1159515b0ee5f79c3f64f404463ee0299b608afd1f83b9ffcaf42edb5f7bb738",
                "md5": "f82f6e1b8dcf0b973445d548d019da1b",
                "sha256": "1e903bb2d438d52a3e23520020e86e6f314f9c6f19653a9cd821af76e1e3f6b1"
            },
            "downloads": -1,
            "filename": "python3_cyberfusion_cluster_apicli-3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "f82f6e1b8dcf0b973445d548d019da1b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 5439,
            "upload_time": "2024-10-29T17:42:10",
            "upload_time_iso_8601": "2024-10-29T17:42:10.071100Z",
            "url": "https://files.pythonhosted.org/packages/11/59/515b0ee5f79c3f64f404463ee0299b608afd1f83b9ffcaf42edb5f7bb738/python3_cyberfusion_cluster_apicli-3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-29 17:42:10",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "python3-cyberfusion-cluster-apicli"
}