| Name | tflowview JSON |
| Version |
0.6.0
JSON |
| download |
| home_page | |
| Summary | A text-based viewer for ECMWF workflow schedulers. |
| upload_time | 2023-01-10 17:32:43 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | CECILL-C |
| keywords |
sms
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# tflowclient
The ``tflowclient`` package (Text-based workFlow scheduler Client) provides all
the necessary bits to build text-based console clients to interact with
various workflow schedulers. For now, only ``SMS`` is supported: see the
``bin/tflowclient_cdp.py`` executable.
The default display is a tree-view of the workload currently being managed by
the workflow scheduler. An alternative display/"app" is available and can
be trigger by adding `-a Cancel`` on the command-line: it allows to select
several root nodes and to cancel (i.e. delete) them.
## Requirements & Dependencies
The ``tflowclient`` package is only compatible with Python >= 3.7.
The ``tflowclient`` package itself only depends on the non-standard ``urwid``
package that is available on PyPi.
Developers will also need to install the ``pytest`` and ``black`` PyPi
packages in order to respectively test the code and format the code.
To use the ``bin/tflowclient_cdp.py`` executable, a ``cdp`` executable needs to
be available in the system's path. Otherwise, its path can be specified in the
user-specific configuration file ``~/.tflowclientrc.ini``.
## Installation
### Manually
Just fetch the code and add the ``src`` directory to your ``PYTHONPATH``.
### Via ``pip``
Install ``pip``'s build package:
pip install build
Build the ``tflowclient`` package (from the repository root directory):
python -m build
After this step, a ready to use pip package should be located in the ``dist``
subdirectory. It may be installed using pip:
pip install ./dist/package_name.tar.gz
## Rules regarding developments
All the Python code (including the code in ``bin`` and ``tests`` subdirectories)
must comply with PEP8. Prior to any commit in the central repository, all
the Python code **must** be automatically formatted using the black formatter:
black .
All the unit tests must succeed at any time. The ``pytest`` launcher should
be used (from the repository root directory):
pytest
## The ``~/.tflowclientrc.ini`` configuration file
The configuration file is optional. You do not need to create it unless you
want to customise some the default configuration
It could look like that:
[logging]
; Activate logging in a ``~/.tflowclient.log`` file for messages with a
; severity greater or equal to ``CRITICAL``.
level = CRITICAL
[urwid]
; The backend for ``urwid``. The other possible value is ``curses``.
backend = raw
[palette]
; The platette that will be used by urwid.
; For example, you might want to print aborted tasks with black
; characters on a ``dark magenta`` background
ABORTED = black,dark magenta
The default ``tflowclient`` palette can be dumped using the
``bin/tflowclient_palette.py`` executable. More details, on the various
color schemes can be obtained in the ``urwid`` documentation.
By default, only 16 colors are available to build the "palette". Some of may
want to expand their horizons... Theoretically, it is possible to support 256
colors (see the configuration) but beware that it is not supported by all
terminals (that's why it's not activated by default).
Use of a 256-colors palette:
[urwid]
backend = raw
terminal_colors = 256
[palette]
ABORTED = black, dark magenta, , g74, #f86
The first to entries of the palette still represent foreground and background
colors for the 16-colors palette but the 4th and 5th elements represents
foreground and background colors for the 256-colors palette
(see https://urwid.readthedocs.io/en/latest/examples/index.html#palette-test-py).
## Extra configuration for SMS/CDP
When running the ``tflowclient_cdp.py`` utility, the server name, user name and
SMS suite to follow have to be specified:
tflowclient_cdp.py -s sms_server -u sms_user -r sms_suite
For a day to day use, default values can be specified in the
``~/.tflowclientrc.ini`` file:
[cdp]
path=path_to_the_cdp_binary
host=sms_server
user=sms_user
suite=sms_suite
``path`` may be omitted if it is properly configured system-wide.
In addition, the user must provide his credentials in a ``~/.smsrc`` file.
The ``~/.smsrc`` file may contain several lines for each of the
server_name/user_name pair the user wants to connect to. The ``.smsrc``
file looks like:
sms_server sms_user sms_user_s_password
The ``~/.smsrc`` file needs to be accessible **only** by the user ("600"
permissions in octal notation).
Raw data
{
"_id": null,
"home_page": "",
"name": "tflowview",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "SMS",
"author": "",
"author_email": "Louis-Fran\u00e7ois Meunier <louis-francois.meunier@meteo.fr>",
"download_url": "https://files.pythonhosted.org/packages/66/54/bdc06c23c41bd74fe84de4856d2ef756031f3557eee2c13eb095d3ae0b75/tflowview-0.6.0.tar.gz",
"platform": null,
"description": "# tflowclient\n\nThe ``tflowclient`` package (Text-based workFlow scheduler Client) provides all\nthe necessary bits to build text-based console clients to interact with\nvarious workflow schedulers. For now, only ``SMS`` is supported: see the\n``bin/tflowclient_cdp.py`` executable.\n\nThe default display is a tree-view of the workload currently being managed by\nthe workflow scheduler. An alternative display/\"app\" is available and can\nbe trigger by adding `-a Cancel`` on the command-line: it allows to select\nseveral root nodes and to cancel (i.e. delete) them.\n\n## Requirements & Dependencies\n\nThe ``tflowclient`` package is only compatible with Python >= 3.7.\n\nThe ``tflowclient`` package itself only depends on the non-standard ``urwid``\npackage that is available on PyPi.\n\nDevelopers will also need to install the ``pytest`` and ``black`` PyPi\npackages in order to respectively test the code and format the code.\n\nTo use the ``bin/tflowclient_cdp.py`` executable, a ``cdp`` executable needs to\nbe available in the system's path. Otherwise, its path can be specified in the\nuser-specific configuration file ``~/.tflowclientrc.ini``.\n\n## Installation\n\n### Manually\n\nJust fetch the code and add the ``src`` directory to your ``PYTHONPATH``.\n\n### Via ``pip``\n\nInstall ``pip``'s build package:\n\n pip install build\n\nBuild the ``tflowclient`` package (from the repository root directory):\n\n python -m build\n\nAfter this step, a ready to use pip package should be located in the ``dist``\nsubdirectory. It may be installed using pip:\n\n pip install ./dist/package_name.tar.gz\n\n## Rules regarding developments\n\nAll the Python code (including the code in ``bin`` and ``tests`` subdirectories)\nmust comply with PEP8. Prior to any commit in the central repository, all\nthe Python code **must** be automatically formatted using the black formatter:\n\n black .\n\nAll the unit tests must succeed at any time. The ``pytest`` launcher should\nbe used (from the repository root directory):\n\n pytest\n\n## The ``~/.tflowclientrc.ini`` configuration file\n\nThe configuration file is optional. You do not need to create it unless you\nwant to customise some the default configuration\n\nIt could look like that:\n\n [logging]\n ; Activate logging in a ``~/.tflowclient.log`` file for messages with a\n ; severity greater or equal to ``CRITICAL``.\n level = CRITICAL\n \n [urwid]\n ; The backend for ``urwid``. The other possible value is ``curses``.\n backend = raw\n \n [palette]\n ; The platette that will be used by urwid.\n ; For example, you might want to print aborted tasks with black\n ; characters on a ``dark magenta`` background\n ABORTED = black,dark magenta\n\nThe default ``tflowclient`` palette can be dumped using the\n``bin/tflowclient_palette.py`` executable. More details, on the various\ncolor schemes can be obtained in the ``urwid`` documentation.\n\nBy default, only 16 colors are available to build the \"palette\". Some of may\nwant to expand their horizons... Theoretically, it is possible to support 256\ncolors (see the configuration) but beware that it is not supported by all\nterminals (that's why it's not activated by default).\n\nUse of a 256-colors palette:\n\n [urwid]\n backend = raw\n terminal_colors = 256\n \n [palette]\n ABORTED = black, dark magenta, , g74, #f86\n\nThe first to entries of the palette still represent foreground and background\ncolors for the 16-colors palette but the 4th and 5th elements represents\nforeground and background colors for the 256-colors palette\n(see https://urwid.readthedocs.io/en/latest/examples/index.html#palette-test-py). \n\n## Extra configuration for SMS/CDP\n\nWhen running the ``tflowclient_cdp.py`` utility, the server name, user name and\nSMS suite to follow have to be specified:\n\n tflowclient_cdp.py -s sms_server -u sms_user -r sms_suite\n\nFor a day to day use, default values can be specified in the\n``~/.tflowclientrc.ini`` file:\n\n [cdp]\n path=path_to_the_cdp_binary\n host=sms_server\n user=sms_user\n suite=sms_suite\n\n``path`` may be omitted if it is properly configured system-wide.\n\nIn addition, the user must provide his credentials in a ``~/.smsrc`` file.\nThe ``~/.smsrc`` file may contain several lines for each of the\nserver_name/user_name pair the user wants to connect to. The ``.smsrc``\nfile looks like:\n\n sms_server sms_user sms_user_s_password\n\nThe ``~/.smsrc`` file needs to be accessible **only** by the user (\"600\"\npermissions in octal notation).\n",
"bugtrack_url": null,
"license": "CECILL-C",
"summary": "A text-based viewer for ECMWF workflow schedulers.",
"version": "0.6.0",
"split_keywords": [
"sms"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ba54cdb8cd96d07eed9997141adbd189f0e190cbded119ca9223f1e1d31b8720",
"md5": "fc14ef02d37f4d0d3e6b09acede3742f",
"sha256": "d7360a3a0f1514ddf37f8f219f5f52be334e882203f280942fef271278026359"
},
"downloads": -1,
"filename": "tflowview-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fc14ef02d37f4d0d3e6b09acede3742f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 65664,
"upload_time": "2023-01-10T17:32:41",
"upload_time_iso_8601": "2023-01-10T17:32:41.531693Z",
"url": "https://files.pythonhosted.org/packages/ba/54/cdb8cd96d07eed9997141adbd189f0e190cbded119ca9223f1e1d31b8720/tflowview-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6654bdc06c23c41bd74fe84de4856d2ef756031f3557eee2c13eb095d3ae0b75",
"md5": "c34129f939f878d75fe7e7a1b9226a6d",
"sha256": "68d95f94e72e86592cb26ebe9d35a2d2311113b516c2bdb5b654e72f262f5ac5"
},
"downloads": -1,
"filename": "tflowview-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "c34129f939f878d75fe7e7a1b9226a6d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 63050,
"upload_time": "2023-01-10T17:32:43",
"upload_time_iso_8601": "2023-01-10T17:32:43.299499Z",
"url": "https://files.pythonhosted.org/packages/66/54/bdc06c23c41bd74fe84de4856d2ef756031f3557eee2c13eb095d3ae0b75/tflowview-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-10 17:32:43",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "tflowview"
}
