runtimepy


Nameruntimepy JSON
Version 3.11.1 PyPI version JSON
download
home_pagehttps://github.com/vkottler/runtimepy
SummaryA framework for implementing Python services.
upload_time2024-03-19 04:16:09
maintainer
docs_urlNone
authorVaughn Kottler
requires_python>=3.11
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <!--
    =====================================
    generator=datazen
    version=3.1.4
    hash=bedc870d38c09f3340b08f2d190a45f6
    =====================================
-->

# runtimepy ([3.11.1](https://pypi.org/project/runtimepy/))

[![python](https://img.shields.io/pypi/pyversions/runtimepy.svg)](https://pypi.org/project/runtimepy/)
![Build Status](https://github.com/vkottler/runtimepy/workflows/Python%20Package/badge.svg)
[![codecov](https://codecov.io/gh/vkottler/runtimepy/branch/master/graphs/badge.svg?branch=master)](https://codecov.io/github/vkottler/runtimepy)
![PyPI - Status](https://img.shields.io/pypi/status/runtimepy)
![Dependents (via libraries.io)](https://img.shields.io/librariesio/dependents/pypi/runtimepy)

*A framework for implementing Python services.*

## Documentation

### Generated

* By [sphinx-apidoc](https://vkottler.github.io/python/sphinx/runtimepy)
(What's [`sphinx-apidoc`](https://www.sphinx-doc.org/en/master/man/sphinx-apidoc.html)?)
* By [pydoc](https://vkottler.github.io/python/pydoc/runtimepy.html)
(What's [`pydoc`](https://docs.python.org/3/library/pydoc.html)?)

## Python Version Support

This package is tested with the following Python minor versions:

* [`python3.11`](https://docs.python.org/3.11/)
* [`python3.12`](https://docs.python.org/3.12/)

## Platform Support

This package is tested on the following platforms:

* `ubuntu-latest`
* `macos-latest`
* `windows-latest`

# Introduction

# Command-line Options

```
$ ./venv3.11/bin/runtimepy -h

usage: runtimepy [-h] [--version] [-v] [-q] [--curses] [--no-uvloop] [-C DIR]
                 {arbiter,server,task,tui,noop} ...

A framework for implementing Python services.

options:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  -v, --verbose         set to increase logging verbosity
  -q, --quiet           set to reduce output
  --curses              whether or not to use curses.wrapper when starting
  --no-uvloop           whether or not to disable uvloop as event loop driver
  -C DIR, --dir DIR     execute from a specific directory

commands:
  {arbiter,server,task,tui,noop}
                        set of available commands
    arbiter             run a connection-arbiter application from a config
    server              run a server for a specific connection factory
    task                run a task from a specific task factory
    tui                 run a terminal interface for the channel environment
    noop                command stub (does nothing)

```

## Sub-command Options

### `arbiter`

```
$ ./venv3.11/bin/runtimepy arbiter -h

usage: runtimepy arbiter [-h] [-i] [-w] configs [configs ...]

positional arguments:
  configs               the configuration to load

options:
  -h, --help            show this help message and exit
  -i, --init_only, --init-only
                        exit after completing initialization
  -w, --wait-for-stop, --wait_for_stop
                        ensure that a 'wait_for_stop' application method is
                        run last

```

### `server`

```
$ ./venv3.11/bin/runtimepy server -h

usage: runtimepy server [-h] [-i] [-w] [--host HOST] [-p PORT] [-u] [-l]
                        factory [configs ...]

positional arguments:
  factory               name of connection factory to create server for
  configs               the configuration to load

options:
  -h, --help            show this help message and exit
  -i, --init_only, --init-only
                        exit after completing initialization
  -w, --wait-for-stop, --wait_for_stop
                        ensure that a 'wait_for_stop' application method is
                        run last
  --host HOST           host address to listen on (default: '0.0.0.0')
  -p PORT, --port PORT  port to listen on (default: 0)
  -u, --udp             whether or not this is a UDP-based server (otherwise
                        it must be a TCP-based server)
  -l, --loopback        if true a client of the same connection type is added

```

### `task`

```
$ ./venv3.11/bin/runtimepy task -h

usage: runtimepy task [-h] [-i] [-w] [-r RATE] factory [configs ...]

positional arguments:
  factory               name of task factory to create task with
  configs               the configuration to load

options:
  -h, --help            show this help message and exit
  -i, --init_only, --init-only
                        exit after completing initialization
  -w, --wait-for-stop, --wait_for_stop
                        ensure that a 'wait_for_stop' application method is
                        run last
  -r RATE, --rate RATE  rate (in Hz) that the task should run (default: 10)

```

### `tui`

```
$ ./venv3.11/bin/runtimepy tui -h

usage: runtimepy tui [-h] [-i ITERATIONS] [-r RATE]

options:
  -h, --help            show this help message and exit
  -i ITERATIONS, --iterations ITERATIONS
                        maximum number of program iterations (if greater than
                        zero, default: 0)
  -r RATE, --rate RATE  frequency (in Hz) to run the interface (default: 60.0
                        Hz)

```

# Internal Dependency Graph

A coarse view of the internal structure and scale of
`runtimepy`'s source.
Generated using [pydeps](https://github.com/thebjorn/pydeps) (via
`mk python-deps`).

![runtimepy's Dependency Graph](im/pydeps.svg)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/vkottler/runtimepy",
    "name": "runtimepy",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": "Vaughn Kottler <vaughnkottler@gmail.com>",
    "keywords": "",
    "author": "Vaughn Kottler",
    "author_email": "Vaughn Kottler <vaughnkottler@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/bf/c8/da65f7bfee2502abeeda0d824284f76be4b3bfff1eb0b256bcedef1e9d30/runtimepy-3.11.1.tar.gz",
    "platform": null,
    "description": "<!--\n    =====================================\n    generator=datazen\n    version=3.1.4\n    hash=bedc870d38c09f3340b08f2d190a45f6\n    =====================================\n-->\n\n# runtimepy ([3.11.1](https://pypi.org/project/runtimepy/))\n\n[![python](https://img.shields.io/pypi/pyversions/runtimepy.svg)](https://pypi.org/project/runtimepy/)\n![Build Status](https://github.com/vkottler/runtimepy/workflows/Python%20Package/badge.svg)\n[![codecov](https://codecov.io/gh/vkottler/runtimepy/branch/master/graphs/badge.svg?branch=master)](https://codecov.io/github/vkottler/runtimepy)\n![PyPI - Status](https://img.shields.io/pypi/status/runtimepy)\n![Dependents (via libraries.io)](https://img.shields.io/librariesio/dependents/pypi/runtimepy)\n\n*A framework for implementing Python services.*\n\n## Documentation\n\n### Generated\n\n* By [sphinx-apidoc](https://vkottler.github.io/python/sphinx/runtimepy)\n(What's [`sphinx-apidoc`](https://www.sphinx-doc.org/en/master/man/sphinx-apidoc.html)?)\n* By [pydoc](https://vkottler.github.io/python/pydoc/runtimepy.html)\n(What's [`pydoc`](https://docs.python.org/3/library/pydoc.html)?)\n\n## Python Version Support\n\nThis package is tested with the following Python minor versions:\n\n* [`python3.11`](https://docs.python.org/3.11/)\n* [`python3.12`](https://docs.python.org/3.12/)\n\n## Platform Support\n\nThis package is tested on the following platforms:\n\n* `ubuntu-latest`\n* `macos-latest`\n* `windows-latest`\n\n# Introduction\n\n# Command-line Options\n\n```\n$ ./venv3.11/bin/runtimepy -h\n\nusage: runtimepy [-h] [--version] [-v] [-q] [--curses] [--no-uvloop] [-C DIR]\n                 {arbiter,server,task,tui,noop} ...\n\nA framework for implementing Python services.\n\noptions:\n  -h, --help            show this help message and exit\n  --version             show program's version number and exit\n  -v, --verbose         set to increase logging verbosity\n  -q, --quiet           set to reduce output\n  --curses              whether or not to use curses.wrapper when starting\n  --no-uvloop           whether or not to disable uvloop as event loop driver\n  -C DIR, --dir DIR     execute from a specific directory\n\ncommands:\n  {arbiter,server,task,tui,noop}\n                        set of available commands\n    arbiter             run a connection-arbiter application from a config\n    server              run a server for a specific connection factory\n    task                run a task from a specific task factory\n    tui                 run a terminal interface for the channel environment\n    noop                command stub (does nothing)\n\n```\n\n## Sub-command Options\n\n### `arbiter`\n\n```\n$ ./venv3.11/bin/runtimepy arbiter -h\n\nusage: runtimepy arbiter [-h] [-i] [-w] configs [configs ...]\n\npositional arguments:\n  configs               the configuration to load\n\noptions:\n  -h, --help            show this help message and exit\n  -i, --init_only, --init-only\n                        exit after completing initialization\n  -w, --wait-for-stop, --wait_for_stop\n                        ensure that a 'wait_for_stop' application method is\n                        run last\n\n```\n\n### `server`\n\n```\n$ ./venv3.11/bin/runtimepy server -h\n\nusage: runtimepy server [-h] [-i] [-w] [--host HOST] [-p PORT] [-u] [-l]\n                        factory [configs ...]\n\npositional arguments:\n  factory               name of connection factory to create server for\n  configs               the configuration to load\n\noptions:\n  -h, --help            show this help message and exit\n  -i, --init_only, --init-only\n                        exit after completing initialization\n  -w, --wait-for-stop, --wait_for_stop\n                        ensure that a 'wait_for_stop' application method is\n                        run last\n  --host HOST           host address to listen on (default: '0.0.0.0')\n  -p PORT, --port PORT  port to listen on (default: 0)\n  -u, --udp             whether or not this is a UDP-based server (otherwise\n                        it must be a TCP-based server)\n  -l, --loopback        if true a client of the same connection type is added\n\n```\n\n### `task`\n\n```\n$ ./venv3.11/bin/runtimepy task -h\n\nusage: runtimepy task [-h] [-i] [-w] [-r RATE] factory [configs ...]\n\npositional arguments:\n  factory               name of task factory to create task with\n  configs               the configuration to load\n\noptions:\n  -h, --help            show this help message and exit\n  -i, --init_only, --init-only\n                        exit after completing initialization\n  -w, --wait-for-stop, --wait_for_stop\n                        ensure that a 'wait_for_stop' application method is\n                        run last\n  -r RATE, --rate RATE  rate (in Hz) that the task should run (default: 10)\n\n```\n\n### `tui`\n\n```\n$ ./venv3.11/bin/runtimepy tui -h\n\nusage: runtimepy tui [-h] [-i ITERATIONS] [-r RATE]\n\noptions:\n  -h, --help            show this help message and exit\n  -i ITERATIONS, --iterations ITERATIONS\n                        maximum number of program iterations (if greater than\n                        zero, default: 0)\n  -r RATE, --rate RATE  frequency (in Hz) to run the interface (default: 60.0\n                        Hz)\n\n```\n\n# Internal Dependency Graph\n\nA coarse view of the internal structure and scale of\n`runtimepy`'s source.\nGenerated using [pydeps](https://github.com/thebjorn/pydeps) (via\n`mk python-deps`).\n\n![runtimepy's Dependency Graph](im/pydeps.svg)\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A framework for implementing Python services.",
    "version": "3.11.1",
    "project_urls": {
        "Homepage": "https://github.com/vkottler/runtimepy"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "537f3eed019dc6d6822550808dcebb8a4a2cce0919deaadb8ae0448a501d49cf",
                "md5": "089030f49fc3eb1211e2f8d4a68d65d2",
                "sha256": "242ccd8fcc3515a7cb10338f5b6d19133efa6bb1d695109d15d359ced7d1a100"
            },
            "downloads": -1,
            "filename": "runtimepy-3.11.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "089030f49fc3eb1211e2f8d4a68d65d2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 187355,
            "upload_time": "2024-03-19T04:16:06",
            "upload_time_iso_8601": "2024-03-19T04:16:06.355057Z",
            "url": "https://files.pythonhosted.org/packages/53/7f/3eed019dc6d6822550808dcebb8a4a2cce0919deaadb8ae0448a501d49cf/runtimepy-3.11.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bfc8da65f7bfee2502abeeda0d824284f76be4b3bfff1eb0b256bcedef1e9d30",
                "md5": "0b7975eff313f355451fa0d804d5dc32",
                "sha256": "c8100c9e2bc12665dc6fcad5b4ceb4d7ae08b71499e0580f50f8eb36edb8c6e7"
            },
            "downloads": -1,
            "filename": "runtimepy-3.11.1.tar.gz",
            "has_sig": false,
            "md5_digest": "0b7975eff313f355451fa0d804d5dc32",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 128036,
            "upload_time": "2024-03-19T04:16:09",
            "upload_time_iso_8601": "2024-03-19T04:16:09.412929Z",
            "url": "https://files.pythonhosted.org/packages/bf/c8/da65f7bfee2502abeeda0d824284f76be4b3bfff1eb0b256bcedef1e9d30/runtimepy-3.11.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-19 04:16:09",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "vkottler",
    "github_project": "runtimepy",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "runtimepy"
}
        
Elapsed time: 0.23273s