tui-executor


Nametui-executor JSON
Version 0.4.1 PyPI version JSON
download
home_pageNone
SummaryExecute Python code in an automatically generated TUI App.
upload_time2024-11-16 17:56:24
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseMIT
keywords tui execute task
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
# TUI Executor

You ever wanted to execute your Python code from a simple TUI without the need to use a REPL or commandline? Look no further, use TUI Executor.


## Installation

Install this package in your virtual environment:

```
$ python3 -m pip install [--upgrade] tui-executor 
```

## Documentation

You can find the documentation at https://rhuygen.github.io/tui-executor/.


## Running the Demo

You can run a demo of the app with the following command:

```shell
$ python3 -m tui_executor.demo
```

This will start the app with a number of tasks that demonstrate the capabilities of the `tui-executor` app.

## Running the app with test tasks

This assumes you have cloned the git repository and navigated to the project folder. There you should do a `pip install -e .` to have a working editable installation.

From the project folder, run the following command to test the app's capabilities:

```shell
$ PYTHONPATH=tests tui-executor --module-path tasks.docs
```

You can add more module paths as argument to the above command. This will create additional TABs for each (sub-)package in that module path.

```shell
$ PYTHONPATH=tests tui-executor --module-path tasks.docs --module-path tasks.specific --module-path tasks.shared
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "tui-executor",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "TUI, execute, task",
    "author": null,
    "author_email": "Rik Huygen <rik.huygen@kuleuven.be>",
    "download_url": "https://files.pythonhosted.org/packages/b0/9e/e4f6859437fb34f036736a3c94eb337a26c19abaad71f56a0ff88d67f2da/tui_executor-0.4.1.tar.gz",
    "platform": null,
    "description": "\n# TUI Executor\n\nYou ever wanted to execute your Python code from a simple TUI without the need to use a REPL or commandline? Look no further, use TUI Executor.\n\n\n## Installation\n\nInstall this package in your virtual environment:\n\n```\n$ python3 -m pip install [--upgrade] tui-executor \n```\n\n## Documentation\n\nYou can find the documentation at https://rhuygen.github.io/tui-executor/.\n\n\n## Running the Demo\n\nYou can run a demo of the app with the following command:\n\n```shell\n$ python3 -m tui_executor.demo\n```\n\nThis will start the app with a number of tasks that demonstrate the capabilities of the `tui-executor` app.\n\n## Running the app with test tasks\n\nThis assumes you have cloned the git repository and navigated to the project folder. There you should do a `pip install -e .` to have a working editable installation.\n\nFrom the project folder, run the following command to test the app's capabilities:\n\n```shell\n$ PYTHONPATH=tests tui-executor --module-path tasks.docs\n```\n\nYou can add more module paths as argument to the above command. This will create additional TABs for each (sub-)package in that module path.\n\n```shell\n$ PYTHONPATH=tests tui-executor --module-path tasks.docs --module-path tasks.specific --module-path tasks.shared\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Execute Python code in an automatically generated TUI App.",
    "version": "0.4.1",
    "project_urls": {
        "documentation": "https://rhuygen.github.io/tui-executor/",
        "repository": "https://github.com/rhuygen/tui-executor"
    },
    "split_keywords": [
        "tui",
        " execute",
        " task"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4070cc20031103e77dc88c23c8644671d81cfabec41ac5d19b392673224ffd43",
                "md5": "9ab5151243174c59c427ac6f2605b923",
                "sha256": "21ddc1240a43b6ed5dd0c0b6f2126f35f4061bd8faf2693be19d38b3e2f67e68"
            },
            "downloads": -1,
            "filename": "tui_executor-0.4.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9ab5151243174c59c427ac6f2605b923",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 66660,
            "upload_time": "2024-11-16T17:56:22",
            "upload_time_iso_8601": "2024-11-16T17:56:22.464935Z",
            "url": "https://files.pythonhosted.org/packages/40/70/cc20031103e77dc88c23c8644671d81cfabec41ac5d19b392673224ffd43/tui_executor-0.4.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b09ee4f6859437fb34f036736a3c94eb337a26c19abaad71f56a0ff88d67f2da",
                "md5": "3bcc967b2b71b99d7bc806cd82ef7192",
                "sha256": "3fd6f38ba543bef5b87ab6a4aca86500d7481d7796e3fbee95020fa35644a2b2"
            },
            "downloads": -1,
            "filename": "tui_executor-0.4.1.tar.gz",
            "has_sig": false,
            "md5_digest": "3bcc967b2b71b99d7bc806cd82ef7192",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 55965,
            "upload_time": "2024-11-16T17:56:24",
            "upload_time_iso_8601": "2024-11-16T17:56:24.342860Z",
            "url": "https://files.pythonhosted.org/packages/b0/9e/e4f6859437fb34f036736a3c94eb337a26c19abaad71f56a0ff88d67f2da/tui_executor-0.4.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-16 17:56:24",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "rhuygen",
    "github_project": "tui-executor",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "tui-executor"
}
        
Elapsed time: 1.03056s