ocui


Nameocui JSON
Version 0.1.1 PyPI version JSON
download
home_pageNone
Summaryocui is a terminal user interface to facilitate the most common tasks around
upload_time2024-10-26 12:14:44
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # `ocui`

[![Python package](https://github.com/fishinthecalculator/ocui/actions/workflows/python-package.yml/badge.svg?branch=main)](https://github.com/fishinthecalculator/ocui/actions/workflows/python-package.yml) 
![Python versions](https://raw.githubusercontent.com/fishinthecalculator/ocui/main/.img/python.svg)
[![PyPI version](https://raw.githubusercontent.com/fishinthecalculator/ocui/master/.img/pypi.svg)](https://pypi.org/project/ocui/)
![License](https://raw.githubusercontent.com/fishinthecalculator/ocui/main/.img/license.svg)

`ocui` is a terminal user interface to facilitate the most common tasks around OCI containers running on a single host. You can create, start and kill containers with few keystrokes, as well as look at logs in real time, or inspect images. `ocui` continually watches the system for changes and offers adequate commands to interact with the system resources.

## Screenshots

### Containers running in the system

![ocui containers](https://raw.githubusercontent.com/fishinthecalculator/ocui/main/.img/screenshot.png)

### Real time logs

![ocui logs](https://raw.githubusercontent.com/fishinthecalculator/ocui/main/.img/logs.png)

### Container creation

![ocui create container](https://raw.githubusercontent.com/fishinthecalculator/ocui/main/.img/container_creation.png)

### Container inspection

![ocui inspect container](https://raw.githubusercontent.com/fishinthecalculator/ocui/main/.img/container_inspection.png)

## Contributing

All contributions are welcome. If you have commit access please remember to setup the authentication hook with

```bash
guix git authenticate --cache-key=channels/ocui --stats "10ed759852825149eb4b08c9b75777111a92048e" "97A2 CB8F B066 F894 9928  CF80 DE9B E0AC E824 6F08"
```

## License

Unless otherwise stated all the files in this repository are to be considered under the GPL 3.0 terms. You are more than welcome to open issues or send patches.

## Helpful initiatives

- This project started during SUSE's [Hack Week 23](https://hackweek.opensuse.org), where I had the time to participate [a project](https://hackweek.opensuse.org/23/projects/forklift-text-based-gui-utility-for-dealing-with-containers) to implement something like `ocui`.
- This project is clearly strongly inspired from [K9s](https://k9scli.io/). Without it I would probably never had found the inspiration for `ocui`.
- The endless nice TUI managers from the community, starting from `top` to `htop`, `glances` and all the others.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "ocui",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "Giacomo Leidi <goodoldpaul@autistici.org>",
    "download_url": "https://files.pythonhosted.org/packages/17/29/5f330110bc1c1715c34af552b03eecfd9d6efe32e4b5fc5eca6ead2363ed/ocui-0.1.1.tar.gz",
    "platform": null,
    "description": "# `ocui`\n\n[![Python package](https://github.com/fishinthecalculator/ocui/actions/workflows/python-package.yml/badge.svg?branch=main)](https://github.com/fishinthecalculator/ocui/actions/workflows/python-package.yml) \n![Python versions](https://raw.githubusercontent.com/fishinthecalculator/ocui/main/.img/python.svg)\n[![PyPI version](https://raw.githubusercontent.com/fishinthecalculator/ocui/master/.img/pypi.svg)](https://pypi.org/project/ocui/)\n![License](https://raw.githubusercontent.com/fishinthecalculator/ocui/main/.img/license.svg)\n\n`ocui` is a terminal user interface to facilitate the most common tasks around OCI containers running on a single host. You can create, start and kill containers with few keystrokes, as well as look at logs in real time, or inspect images. `ocui` continually watches the system for changes and offers adequate commands to interact with the system resources.\n\n## Screenshots\n\n### Containers running in the system\n\n![ocui containers](https://raw.githubusercontent.com/fishinthecalculator/ocui/main/.img/screenshot.png)\n\n### Real time logs\n\n![ocui logs](https://raw.githubusercontent.com/fishinthecalculator/ocui/main/.img/logs.png)\n\n### Container creation\n\n![ocui create container](https://raw.githubusercontent.com/fishinthecalculator/ocui/main/.img/container_creation.png)\n\n### Container inspection\n\n![ocui inspect container](https://raw.githubusercontent.com/fishinthecalculator/ocui/main/.img/container_inspection.png)\n\n## Contributing\n\nAll contributions are welcome. If you have commit access please remember to setup the authentication hook with\n\n```bash\nguix git authenticate --cache-key=channels/ocui --stats \"10ed759852825149eb4b08c9b75777111a92048e\" \"97A2 CB8F B066 F894 9928  CF80 DE9B E0AC E824 6F08\"\n```\n\n## License\n\nUnless otherwise stated all the files in this repository are to be considered under the GPL 3.0 terms. You are more than welcome to open issues or send patches.\n\n## Helpful initiatives\n\n- This project started during SUSE's [Hack Week 23](https://hackweek.opensuse.org), where I had the time to participate [a project](https://hackweek.opensuse.org/23/projects/forklift-text-based-gui-utility-for-dealing-with-containers) to implement something like `ocui`.\n- This project is clearly strongly inspired from [K9s](https://k9scli.io/). Without it I would probably never had found the inspiration for `ocui`.\n- The endless nice TUI managers from the community, starting from `top` to `htop`, `glances` and all the others.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "ocui is a terminal user interface to facilitate the most common tasks around",
    "version": "0.1.1",
    "project_urls": {
        "Home": "https://github.com/fishinthecalculator/ocui"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "64b53067c834b83ffb5cc05a84dca6c612f7e9ffe12a55285376e7157c87a8bf",
                "md5": "2ef1b06c6c989b77ac82c7676dc30c73",
                "sha256": "de6ab7f122b1e2dcd35710b649a234d584c73a354519f1e9ab7654663cd1b880"
            },
            "downloads": -1,
            "filename": "ocui-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2ef1b06c6c989b77ac82c7676dc30c73",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 31623,
            "upload_time": "2024-10-26T12:14:41",
            "upload_time_iso_8601": "2024-10-26T12:14:41.706853Z",
            "url": "https://files.pythonhosted.org/packages/64/b5/3067c834b83ffb5cc05a84dca6c612f7e9ffe12a55285376e7157c87a8bf/ocui-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "17295f330110bc1c1715c34af552b03eecfd9d6efe32e4b5fc5eca6ead2363ed",
                "md5": "d281cd44e24fa11f418b6e45b6d0a3cf",
                "sha256": "6eaccbcf4e724f7a92f0c8d1b8b7d3c405770da972e126ec5ea55d75769195d7"
            },
            "downloads": -1,
            "filename": "ocui-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "d281cd44e24fa11f418b6e45b6d0a3cf",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 582714,
            "upload_time": "2024-10-26T12:14:44",
            "upload_time_iso_8601": "2024-10-26T12:14:44.112591Z",
            "url": "https://files.pythonhosted.org/packages/17/29/5f330110bc1c1715c34af552b03eecfd9d6efe32e4b5fc5eca6ead2363ed/ocui-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-26 12:14:44",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "fishinthecalculator",
    "github_project": "ocui",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "ocui"
}
        
Elapsed time: 0.93624s