ai4-cli


Nameai4-cli JSON
Version 0.1.0 PyPI version JSON
download
home_pagehttps://github.com/ai4os/ai4-cli
SummaryAI4 CLI tools and API library
upload_time2024-09-10 14:02:31
maintainerNone
docs_urlNone
authorAlvaro Lopez Garcia
requires_python<4.0,>=3.10
licenseGPL-3
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # AI4 CLI tools and API library

[![GitHub license](https://img.shields.io/github/license/ai4os/ai4-cli.svg)](https://github.com/ai4os/ai4-cli/blob/main/LICENSE)
[![GitHub release](https://img.shields.io/github/release/ai4os/ai4-cli.svg)](https://github.com/ai4os/ai4-cli/releases)
[![PyPI](https://img.shields.io/pypi/v/ai4-cli.svg)](https://pypi.python.org/pypi/ai4-cli)
[![Python versions](https://img.shields.io/pypi/pyversions/ai4-cli.svg)](https://pypi.python.org/pypi/ai4-cli)

Command line utilities for the AI4OS ([AI4EOSC](https://ai4eosc.eu/), [iMagine](https://imagine-ai.eu)) platforms.

## Installation

The reccomended way to install the AI4 CLI tools is using pip:

    $ pip install ai4-cli

## Configuration

The `ai4-cli` package will load the needed configuration from environment
variables whenever possible. In order to do so, it will read the `.env.ai4`
file in the current working directory, if it exists. If you want to use any
other file you can set the `AI4_DOTENV_FILE` environment variable to the path
of the file that you want to use.

The file can contain the following variables:

- `AI4_API_ENDPOINT`: The URL of the AI4OS compatible API.
- `AI4_API_VERSION`: The version of the API to use. Currently only `v1` is
  supported.
- `AI4_DEBUG`: If set to True, the CLI will output debug information.

## Usage

The `ai4-cli` package provides a set of subcommands that can be used to interact
with the AI4OS platform. The available subcommands can be listed using the
`ai4-cli --help` command.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ai4os/ai4-cli",
    "name": "ai4-cli",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.10",
    "maintainer_email": null,
    "keywords": null,
    "author": "Alvaro Lopez Garcia",
    "author_email": "aloga@ifca.unican.es",
    "download_url": "https://files.pythonhosted.org/packages/8c/3a/3fb9d0a39b2e720e7735fe6fb9c9ce20cfef337766d3625c045b26ebd3a0/ai4_cli-0.1.0.tar.gz",
    "platform": null,
    "description": "# AI4 CLI tools and API library\n\n[![GitHub license](https://img.shields.io/github/license/ai4os/ai4-cli.svg)](https://github.com/ai4os/ai4-cli/blob/main/LICENSE)\n[![GitHub release](https://img.shields.io/github/release/ai4os/ai4-cli.svg)](https://github.com/ai4os/ai4-cli/releases)\n[![PyPI](https://img.shields.io/pypi/v/ai4-cli.svg)](https://pypi.python.org/pypi/ai4-cli)\n[![Python versions](https://img.shields.io/pypi/pyversions/ai4-cli.svg)](https://pypi.python.org/pypi/ai4-cli)\n\nCommand line utilities for the AI4OS ([AI4EOSC](https://ai4eosc.eu/), [iMagine](https://imagine-ai.eu)) platforms.\n\n## Installation\n\nThe reccomended way to install the AI4 CLI tools is using pip:\n\n    $ pip install ai4-cli\n\n## Configuration\n\nThe `ai4-cli` package will load the needed configuration from environment\nvariables whenever possible. In order to do so, it will read the `.env.ai4`\nfile in the current working directory, if it exists. If you want to use any\nother file you can set the `AI4_DOTENV_FILE` environment variable to the path\nof the file that you want to use.\n\nThe file can contain the following variables:\n\n- `AI4_API_ENDPOINT`: The URL of the AI4OS compatible API.\n- `AI4_API_VERSION`: The version of the API to use. Currently only `v1` is\n  supported.\n- `AI4_DEBUG`: If set to True, the CLI will output debug information.\n\n## Usage\n\nThe `ai4-cli` package provides a set of subcommands that can be used to interact\nwith the AI4OS platform. The available subcommands can be listed using the\n`ai4-cli --help` command.\n",
    "bugtrack_url": null,
    "license": "GPL-3",
    "summary": "AI4 CLI tools and API library",
    "version": "0.1.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/ai4os/ai4-clie/issues",
        "Homepage": "https://github.com/ai4os/ai4-cli",
        "Repository": "https://github.com/ai4os/ai4-cli"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1f6673714e95e260e2335f56e2d4791c9c83af20da71d19673eed0227e119011",
                "md5": "eea16a9a4ce6c7e56dc0ff2a4e8c7432",
                "sha256": "ea0c52cbc43f629f6fb214740ece9a35e457601c18c2629511f85d347a4b2c5c"
            },
            "downloads": -1,
            "filename": "ai4_cli-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "eea16a9a4ce6c7e56dc0ff2a4e8c7432",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 28188,
            "upload_time": "2024-09-10T14:02:29",
            "upload_time_iso_8601": "2024-09-10T14:02:29.872118Z",
            "url": "https://files.pythonhosted.org/packages/1f/66/73714e95e260e2335f56e2d4791c9c83af20da71d19673eed0227e119011/ai4_cli-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8c3a3fb9d0a39b2e720e7735fe6fb9c9ce20cfef337766d3625c045b26ebd3a0",
                "md5": "1fd98a5f684e880318bf1c65d2377242",
                "sha256": "432c80686afbf54e99458fecc13bc58393a65e465440591ea5d897e1203ac30b"
            },
            "downloads": -1,
            "filename": "ai4_cli-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "1fd98a5f684e880318bf1c65d2377242",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.10",
            "size": 24151,
            "upload_time": "2024-09-10T14:02:31",
            "upload_time_iso_8601": "2024-09-10T14:02:31.439910Z",
            "url": "https://files.pythonhosted.org/packages/8c/3a/3fb9d0a39b2e720e7735fe6fb9c9ce20cfef337766d3625c045b26ebd3a0/ai4_cli-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-10 14:02:31",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ai4os",
    "github_project": "ai4-cli",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "ai4-cli"
}
        
Elapsed time: 1.55399s