giza-cli


Namegiza-cli JSON
Version 0.18.1 PyPI version JSON
download
home_pageNone
SummaryCLI for interacting with Giza
upload_time2024-09-10 09:09:12
maintainerNone
docs_urlNone
authorGonzalo Mellizo-Soto
requires_python<4.0,>=3.11
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Giza Command Line Interface

[![GitHub Workflow Status](https://github.com/gizatechxyz/giza-cli/actions/workflows/onpush.yml/badge.svg)](https://github.com/gizatechxyz/giza-cli/actions/workflows/onpush.yml)
[![Project license](https://img.shields.io/github/license/gizatechxyz/orion.svg?style=flat-square)](LICENSE)
[![Pull Requests welcome](https://img.shields.io/badge/PRs-welcome-ff69b4.svg?style=flat-square)](https://github.com/gizatechxyz/orion/issues?q=is%3Aissue+is%3Aopen)
[![Join the community](https://dcbadge.vercel.app/api/server/FR3Cd88x6r?style=flat-square)](https://discord.gg/FR3Cd88x6r)
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->

```text
  _______  __   ________      ___           ______  __       __
 /  _____||  | |       /     /   \         /      ||  |     |  |
|  |  __  |  | `---/  /     /  ^  \       |  ,----'|  |     |  |
|  | |_ | |  |    /  /     /  /_\  \      |  |     |  |     |  |
|  |__| | |  |   /  /----./  _____  \     |  `----.|  `----.|  |
 \______| |__|  /________/__/     \__\     \______||_______||__|

```

Welcome to Giza CLI!

This CLI provides the utilities to interact with Giza using the terminal.

**Disclaimer**: this is still in an experimental stage so the functionality is subject to change.

- [Giza Command Line Interface](#giza-command-line-interface)
  - [🚀 Installation](#-installation)
    - [Recommended installation with pipx](#recommended-installation-with-pipx)
    - [Install from PyPi](#install-from-pypi)
    - [Installing from source](#installing-from-source)
  - [📚 Documentation](#-documentation)
  - [🌟 What's new](#-whats-new)
  - [🤝 Join the community!](#-join-the-community)
  - [Contributors ✨](#contributors-)
  - [License](#license)

## 🚀 Installation

### Recommended installation with pipx

[pipx](https://pypa.github.io/pipx/) allows to install the dependency in an isolated environment. With this we can make sure that it does not conflict with any of our installed dependencies.

```bash
pipx install giza-cli
```

### Install from PyPi

For the latest release:

```bash
pip install giza-cli
```

### Installing from source

Clone the repository and install it with `pip`:

```bash
    git clone git@github.com:gizatechxyz/giza-cli.git
    cd giza-cli
    pip install .
```

Or install it directly from the repo:

```bash
  pip install git+ssh://git@github.com/gizatechxyz/giza-cli.git
```

## 📚 Documentation

You can check our official docs [here](https://cli.gizatech.xyz).

- **Examples** includes examples on how to use the CLI functionalities.

- **Resources** brings the documentation of the different resources and actions that can be done with the CLI.

- 🧠 **Reference** for the API reference and internals of the CLI.

## 🌟 What's new

For a detailed list of changes, please refer to the [CHANGELOG](CHANGELOG.md) file.

## 🤝 Join the community!

Join the community and help build a safer and transparent AI in our [Discord](https://discord.gg/Kt24CsMb5k)!

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
  <tbody>
    <tr>
      <td align="center" valign="top" width="14.28%"><a href="https://es.linkedin.com/in/gonzalo-mellizo-soto-diaz-590260108"><img src="https://avatars.githubusercontent.com/u/18899187?v=4?s=100" width="100px;" alt="Gonzalo Mellizo"/><br /><sub><b>Gonzalo Mellizo</b></sub></a><br /><a href="https://github.com/gizatechxyz/giza-cli/commits?author=Gonmeso" title="Code">💻</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/omahs"><img src="https://avatars.githubusercontent.com/u/73983677?v=4?s=100" width="100px;" alt="omahs"/><br /><sub><b>omahs</b></sub></a><br /><a href="https://github.com/gizatechxyz/giza-cli/commits?author=omahs" title="Documentation">📖</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/franalgaba"><img src="https://avatars.githubusercontent.com/u/24293857?v=4?s=100" width="100px;" alt="Fran Algaba"/><br /><sub><b>Fran Algaba</b></sub></a><br /><a href="https://github.com/gizatechxyz/giza-cli/commits?author=franalgaba" title="Documentation">📖</a></td>
    </tr>
  </tbody>
</table>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

## License

[MIT](https://choosealicense.com/licenses/mit/)


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "giza-cli",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.11",
    "maintainer_email": null,
    "keywords": null,
    "author": "Gonzalo Mellizo-Soto",
    "author_email": "gonzalo@gizatech.xyz",
    "download_url": "https://files.pythonhosted.org/packages/4c/a4/07daab20974a8cae33b87bdf9cad071ff7b2c0a87ac706b4a56d67c11db9/giza_cli-0.18.1.tar.gz",
    "platform": null,
    "description": "# Giza Command Line Interface\n\n[![GitHub Workflow Status](https://github.com/gizatechxyz/giza-cli/actions/workflows/onpush.yml/badge.svg)](https://github.com/gizatechxyz/giza-cli/actions/workflows/onpush.yml)\n[![Project license](https://img.shields.io/github/license/gizatechxyz/orion.svg?style=flat-square)](LICENSE)\n[![Pull Requests welcome](https://img.shields.io/badge/PRs-welcome-ff69b4.svg?style=flat-square)](https://github.com/gizatechxyz/orion/issues?q=is%3Aissue+is%3Aopen)\n[![Join the community](https://dcbadge.vercel.app/api/server/FR3Cd88x6r?style=flat-square)](https://discord.gg/FR3Cd88x6r)\n<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->\n[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)\n<!-- ALL-CONTRIBUTORS-BADGE:END -->\n\n```text\n  _______  __   ________      ___           ______  __       __\n /  _____||  | |       /     /   \\         /      ||  |     |  |\n|  |  __  |  | `---/  /     /  ^  \\       |  ,----'|  |     |  |\n|  | |_ | |  |    /  /     /  /_\\  \\      |  |     |  |     |  |\n|  |__| | |  |   /  /----./  _____  \\     |  `----.|  `----.|  |\n \\______| |__|  /________/__/     \\__\\     \\______||_______||__|\n\n```\n\nWelcome to Giza CLI!\n\nThis CLI provides the utilities to interact with Giza using the terminal.\n\n**Disclaimer**: this is still in an experimental stage so the functionality is subject to change.\n\n- [Giza Command Line Interface](#giza-command-line-interface)\n  - [\ud83d\ude80 Installation](#-installation)\n    - [Recommended installation with pipx](#recommended-installation-with-pipx)\n    - [Install from PyPi](#install-from-pypi)\n    - [Installing from source](#installing-from-source)\n  - [\ud83d\udcda Documentation](#-documentation)\n  - [\ud83c\udf1f What's new](#-whats-new)\n  - [\ud83e\udd1d Join the community!](#-join-the-community)\n  - [Contributors \u2728](#contributors-)\n  - [License](#license)\n\n## \ud83d\ude80 Installation\n\n### Recommended installation with pipx\n\n[pipx](https://pypa.github.io/pipx/) allows to install the dependency in an isolated environment. With this we can make sure that it does not conflict with any of our installed dependencies.\n\n```bash\npipx install giza-cli\n```\n\n### Install from PyPi\n\nFor the latest release:\n\n```bash\npip install giza-cli\n```\n\n### Installing from source\n\nClone the repository and install it with `pip`:\n\n```bash\n    git clone git@github.com:gizatechxyz/giza-cli.git\n    cd giza-cli\n    pip install .\n```\n\nOr install it directly from the repo:\n\n```bash\n  pip install git+ssh://git@github.com/gizatechxyz/giza-cli.git\n```\n\n## \ud83d\udcda Documentation\n\nYou can check our official docs [here](https://cli.gizatech.xyz).\n\n- **Examples** includes examples on how to use the CLI functionalities.\n\n- **Resources** brings the documentation of the different resources and actions that can be done with the CLI.\n\n- \ud83e\udde0 **Reference** for the API reference and internals of the CLI.\n\n## \ud83c\udf1f What's new\n\nFor a detailed list of changes, please refer to the [CHANGELOG](CHANGELOG.md) file.\n\n## \ud83e\udd1d Join the community!\n\nJoin the community and help build a safer and transparent AI in our [Discord](https://discord.gg/Kt24CsMb5k)!\n\n## Contributors \u2728\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->\n<!-- prettier-ignore-start -->\n<!-- markdownlint-disable -->\n<table>\n  <tbody>\n    <tr>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://es.linkedin.com/in/gonzalo-mellizo-soto-diaz-590260108\"><img src=\"https://avatars.githubusercontent.com/u/18899187?v=4?s=100\" width=\"100px;\" alt=\"Gonzalo Mellizo\"/><br /><sub><b>Gonzalo Mellizo</b></sub></a><br /><a href=\"https://github.com/gizatechxyz/giza-cli/commits?author=Gonmeso\" title=\"Code\">\ud83d\udcbb</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/omahs\"><img src=\"https://avatars.githubusercontent.com/u/73983677?v=4?s=100\" width=\"100px;\" alt=\"omahs\"/><br /><sub><b>omahs</b></sub></a><br /><a href=\"https://github.com/gizatechxyz/giza-cli/commits?author=omahs\" title=\"Documentation\">\ud83d\udcd6</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/franalgaba\"><img src=\"https://avatars.githubusercontent.com/u/24293857?v=4?s=100\" width=\"100px;\" alt=\"Fran Algaba\"/><br /><sub><b>Fran Algaba</b></sub></a><br /><a href=\"https://github.com/gizatechxyz/giza-cli/commits?author=franalgaba\" title=\"Documentation\">\ud83d\udcd6</a></td>\n    </tr>\n  </tbody>\n</table>\n\n<!-- markdownlint-restore -->\n<!-- prettier-ignore-end -->\n\n<!-- ALL-CONTRIBUTORS-LIST:END -->\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "CLI for interacting with Giza",
    "version": "0.18.1",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3f957c7064be6d02b3d19b5eeff5e9d198b21c82ff420cee74cc7bdae70ba036",
                "md5": "d3ec39f60c16671ce93774e373686e3f",
                "sha256": "a5d0bdab81a0139ef010a31b91aa813a440e451a7fd477db961979e7e0591b10"
            },
            "downloads": -1,
            "filename": "giza_cli-0.18.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d3ec39f60c16671ce93774e373686e3f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.11",
            "size": 52675,
            "upload_time": "2024-09-10T09:09:11",
            "upload_time_iso_8601": "2024-09-10T09:09:11.036334Z",
            "url": "https://files.pythonhosted.org/packages/3f/95/7c7064be6d02b3d19b5eeff5e9d198b21c82ff420cee74cc7bdae70ba036/giza_cli-0.18.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4ca407daab20974a8cae33b87bdf9cad071ff7b2c0a87ac706b4a56d67c11db9",
                "md5": "38cd293f1e0a1c9ad0686dc3d8701915",
                "sha256": "673c40a98ea209a1a4d7085ad2c6bc1a7e5f50b1b252b0f139089e7bc4758378"
            },
            "downloads": -1,
            "filename": "giza_cli-0.18.1.tar.gz",
            "has_sig": false,
            "md5_digest": "38cd293f1e0a1c9ad0686dc3d8701915",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.11",
            "size": 37187,
            "upload_time": "2024-09-10T09:09:12",
            "upload_time_iso_8601": "2024-09-10T09:09:12.462954Z",
            "url": "https://files.pythonhosted.org/packages/4c/a4/07daab20974a8cae33b87bdf9cad071ff7b2c0a87ac706b4a56d67c11db9/giza_cli-0.18.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-10 09:09:12",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "giza-cli"
}
        
Elapsed time: 0.28723s