Tellie


NameTellie JSON
Version 0.0.1 PyPI version JSON
download
home_page
SummaryTele
upload_time2023-05-16 15:43:47
maintainer
docs_urlNone
author
requires_python
licenseBSD
keywords tele xml-rpc xmlrpc jsonrpc
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            =========================================================
Tellie CLI
=========================================================

Download and install the latest release::

    pip install -U tellie

.. contents::
   :local:
   :backlinks: top

Overview
--------

Tellie carries three completing uses:

(1) with command line arguments
(2) as an interactive shell
(3) as a client library


Key features:

- provides an API very close to the Tele API, through JSON-RPC and XML-RPC
- single executable ``tellie.py``, no external dependency
- helpers for ``search``, for data model introspection, etc...
- simplified syntax for search ``domain`` and ``fields``
- full API accessible on the ``Client.env`` environment
- the module can be imported and used as a library: ``from tellie import Client``
- supports Python 3.5 and above, and Python 2.7



.. _command-line:

Command line arguments
----------------------

Arguments::

    $ tellie --help

    Usage: tellie.py [options] [search_term_or_id [search_term_or_id ...]]

    Inspect data on Tele objects.  Use interactively or query a model (-m) and
    pass search terms or ids as positional parameters after the options.

    Options:
      --version             show program's version number and exit
      -h, --help            show this help message and exit
      -l, --list            list sections of the configuration
      --env=ENV             read connection settings from the given section
      -c CONFIG, --config=CONFIG
                            specify alternate config file (default: 'tellie.ini')
      --server=SERVER       full URL of the server (default:
                            http://localhost:9000/xmlrpc)
      -d DB, --db=DB        database
      -u USER, --user=USER  username
      -p PASSWORD, --password=PASSWORD
                            password, or it will be requested on login
      -m MODEL, --model=MODEL
                            the type of object to find
      -f FIELDS, --fields=FIELDS
                            restrict the output to certain fields (multiple
                            allowed)
      -i, --interact        use interactively; default when no model is queried
      -v, --verbose         verbose
    $ #


Example::

    $ tellie -d demo -m res.partner -f name -f lang 1
    "name","lang"
    "Your Company","en_US"

::

    $ tellie -d demo -m res.groups -f full_name 'id > 0'
    "full_name"
    "Administration / Access Rights"
    "Administration / Configuration"
    "Human Resources / Employee"
    "Usability / Multi Companies"
    "Usability / Extended View"
    "Usability / Technical Features"
    "Sales Management / User"
    "Sales Management / Manager"
    "Partner Manager"



.. _interactive-mode:

Interactive use
---------------

Edit ``tellie.ini`` and declare the environment(s)::

    [DEFAULT]
    scheme = http
    host = localhost
    port = 9000
    database = tele
    username = tele

    [demo]
    username = demo
    password = demo
    protocol = xmlrpc

    [demo_jsonrpc]
    username = demo
    password = demo
    protocol = jsonrpc

    [local]
    scheme = local
    options = -c /opt/tele/tele.conf --without-demo all


Connect to the Tele server::

    tellie --list
    tellie --env demo


This is a sample session::

    >>> env['res.users']
    <Model 'res.users'>
    >>> env['res.users'].search_count()
    4
    >>> crons = env['ir.cron'].with_context(active_test=False).search([])
    >>> crons.read('active name')
    [{'active': True, 'id': 5, 'name': 'Calendar: Event Reminder'},
     {'active': False, 'id': 4, 'name': 'Mail: Fetchmail Service'}]
    >>> #
    >>> env.modules('delivery')
    {'uninstalled': ['delivery', 'website_sale_delivery']}
    >>> env.upgrade('base')
    1 module(s) selected
    42 module(s) to process:
      to upgrade    account
      to upgrade    account_chart
      to upgrade    account_tax_include
      to upgrade    base
      ...
    >>> #


.. note::

   Use the ``--verbose`` switch to see what happens behind the scene.
   Lines are truncated at 79 chars.  Use ``-vv`` or ``-vvv`` to print
   more.


.. note::

   To preserve the history of commands when closing the session, first
   create an empty file in your home directory:
   ``touch ~/.tellie_history``

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "Tellie",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "tele xml-rpc xmlrpc jsonrpc",
    "author": "",
    "author_email": "account@tele.studio",
    "download_url": "https://files.pythonhosted.org/packages/a4/a0/2e58f58a6f2f760f45e27199ee53edfabc360fdba5cbd33daa045e6522cd/Tellie-0.0.1.tar.gz",
    "platform": "any",
    "description": "=========================================================\nTellie CLI\n=========================================================\n\nDownload and install the latest release::\n\n    pip install -U tellie\n\n.. contents::\n   :local:\n   :backlinks: top\n\nOverview\n--------\n\nTellie carries three completing uses:\n\n(1) with command line arguments\n(2) as an interactive shell\n(3) as a client library\n\n\nKey features:\n\n- provides an API very close to the Tele API, through JSON-RPC and XML-RPC\n- single executable ``tellie.py``, no external dependency\n- helpers for ``search``, for data model introspection, etc...\n- simplified syntax for search ``domain`` and ``fields``\n- full API accessible on the ``Client.env`` environment\n- the module can be imported and used as a library: ``from tellie import Client``\n- supports Python 3.5 and above, and Python 2.7\n\n\n\n.. _command-line:\n\nCommand line arguments\n----------------------\n\nArguments::\n\n    $ tellie --help\n\n    Usage: tellie.py [options] [search_term_or_id [search_term_or_id ...]]\n\n    Inspect data on Tele objects.  Use interactively or query a model (-m) and\n    pass search terms or ids as positional parameters after the options.\n\n    Options:\n      --version             show program's version number and exit\n      -h, --help            show this help message and exit\n      -l, --list            list sections of the configuration\n      --env=ENV             read connection settings from the given section\n      -c CONFIG, --config=CONFIG\n                            specify alternate config file (default: 'tellie.ini')\n      --server=SERVER       full URL of the server (default:\n                            http://localhost:9000/xmlrpc)\n      -d DB, --db=DB        database\n      -u USER, --user=USER  username\n      -p PASSWORD, --password=PASSWORD\n                            password, or it will be requested on login\n      -m MODEL, --model=MODEL\n                            the type of object to find\n      -f FIELDS, --fields=FIELDS\n                            restrict the output to certain fields (multiple\n                            allowed)\n      -i, --interact        use interactively; default when no model is queried\n      -v, --verbose         verbose\n    $ #\n\n\nExample::\n\n    $ tellie -d demo -m res.partner -f name -f lang 1\n    \"name\",\"lang\"\n    \"Your Company\",\"en_US\"\n\n::\n\n    $ tellie -d demo -m res.groups -f full_name 'id > 0'\n    \"full_name\"\n    \"Administration / Access Rights\"\n    \"Administration / Configuration\"\n    \"Human Resources / Employee\"\n    \"Usability / Multi Companies\"\n    \"Usability / Extended View\"\n    \"Usability / Technical Features\"\n    \"Sales Management / User\"\n    \"Sales Management / Manager\"\n    \"Partner Manager\"\n\n\n\n.. _interactive-mode:\n\nInteractive use\n---------------\n\nEdit ``tellie.ini`` and declare the environment(s)::\n\n    [DEFAULT]\n    scheme = http\n    host = localhost\n    port = 9000\n    database = tele\n    username = tele\n\n    [demo]\n    username = demo\n    password = demo\n    protocol = xmlrpc\n\n    [demo_jsonrpc]\n    username = demo\n    password = demo\n    protocol = jsonrpc\n\n    [local]\n    scheme = local\n    options = -c /opt/tele/tele.conf --without-demo all\n\n\nConnect to the Tele server::\n\n    tellie --list\n    tellie --env demo\n\n\nThis is a sample session::\n\n    >>> env['res.users']\n    <Model 'res.users'>\n    >>> env['res.users'].search_count()\n    4\n    >>> crons = env['ir.cron'].with_context(active_test=False).search([])\n    >>> crons.read('active name')\n    [{'active': True, 'id': 5, 'name': 'Calendar: Event Reminder'},\n     {'active': False, 'id': 4, 'name': 'Mail: Fetchmail Service'}]\n    >>> #\n    >>> env.modules('delivery')\n    {'uninstalled': ['delivery', 'website_sale_delivery']}\n    >>> env.upgrade('base')\n    1 module(s) selected\n    42 module(s) to process:\n      to upgrade    account\n      to upgrade    account_chart\n      to upgrade    account_tax_include\n      to upgrade    base\n      ...\n    >>> #\n\n\n.. note::\n\n   Use the ``--verbose`` switch to see what happens behind the scene.\n   Lines are truncated at 79 chars.  Use ``-vv`` or ``-vvv`` to print\n   more.\n\n\n.. note::\n\n   To preserve the history of commands when closing the session, first\n   create an empty file in your home directory:\n   ``touch ~/.tellie_history``\n",
    "bugtrack_url": null,
    "license": "BSD",
    "summary": "Tele",
    "version": "0.0.1",
    "project_urls": null,
    "split_keywords": [
        "tele",
        "xml-rpc",
        "xmlrpc",
        "jsonrpc"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4ff962dd34b3dd835762d17e276b70539fc9fd7f91143d5df384f4dc9d76c2fc",
                "md5": "62729f2011a6f56823c943e72b9b1d41",
                "sha256": "89532331bd2320dafd01b9583f04c5397890cbcf07962a184822d400555806b7"
            },
            "downloads": -1,
            "filename": "Tellie-0.0.1-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "62729f2011a6f56823c943e72b9b1d41",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 22714,
            "upload_time": "2023-05-16T15:43:46",
            "upload_time_iso_8601": "2023-05-16T15:43:46.104040Z",
            "url": "https://files.pythonhosted.org/packages/4f/f9/62dd34b3dd835762d17e276b70539fc9fd7f91143d5df384f4dc9d76c2fc/Tellie-0.0.1-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a4a02e58f58a6f2f760f45e27199ee53edfabc360fdba5cbd33daa045e6522cd",
                "md5": "8c48bac24193ff7077691ece0ec0d5d6",
                "sha256": "a6131fabe825ca2db80153a62678b73c53186457ac552d52fd03b462f7e59bf6"
            },
            "downloads": -1,
            "filename": "Tellie-0.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "8c48bac24193ff7077691ece0ec0d5d6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 22514,
            "upload_time": "2023-05-16T15:43:47",
            "upload_time_iso_8601": "2023-05-16T15:43:47.688021Z",
            "url": "https://files.pythonhosted.org/packages/a4/a0/2e58f58a6f2f760f45e27199ee53edfabc360fdba5cbd33daa045e6522cd/Tellie-0.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-05-16 15:43:47",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "tellie"
}
        
Elapsed time: 0.06756s