{"id":13936802,"url":"https://github.com/tinyerp/erppeek","last_synced_at":"2025-07-19T22:32:25.278Z","repository":{"id":2824801,"uuid":"3826963","full_name":"tinyerp/erppeek","owner":"tinyerp","description":"A versatile tool for Odoo / OpenERP.     ***  Forked as Odooly  ⟶","archived":false,"fork":false,"pushed_at":"2022-09-23T12:06:54.000Z","size":693,"stargazers_count":169,"open_issues_count":15,"forks_count":99,"subscribers_count":29,"default_branch":"master","last_synced_at":"2024-08-08T23:24:31.574Z","etag":null,"topics":["cli","odoo","odoo-apps","odoo-tooling","openerp","python"],"latest_commit_sha":null,"homepage":"https://github.com/tinyerp/odooly","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tinyerp.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGES.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-03-25T20:12:33.000Z","updated_at":"2024-07-25T15:07:57.000Z","dependencies_parsed_at":"2023-01-11T16:12:41.986Z","dependency_job_id":null,"html_url":"https://github.com/tinyerp/erppeek","commit_stats":null,"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tinyerp%2Ferppeek","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tinyerp%2Ferppeek/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tinyerp%2Ferppeek/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tinyerp%2Ferppeek/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tinyerp","download_url":"https://codeload.github.com/tinyerp/erppeek/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226693897,"owners_count":17667757,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","odoo","odoo-apps","odoo-tooling","openerp","python"],"created_at":"2024-08-07T23:03:00.797Z","updated_at":"2024-11-27T05:30:32.500Z","avatar_url":"https://github.com/tinyerp.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"==========================================================\nERPpeek, a versatile tool for browsing Odoo / OpenERP data\n==========================================================\n\nDownload and install the latest release::\n\n    pip install -U erppeek\n\n.. contents::\n   :local:\n   :backlinks: top\n\nDocumentation and tutorial: http://erppeek.readthedocs.org\n\nCI tests: https://travis-ci.org/tinyerp/erppeek\n\n\nOverview\n--------\n\nERPpeek 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- single executable ``erppeek.py``, no external dependency\n- wrappers for ``search+read``, for data model introspection, etc...\n- simpler syntax for ``domain`` and ``fields``\n- full API accessible on the ``Client`` object for OpenERP 5.0 through Odoo 11.0\n- the module can be imported and used as a library: ``from erppeek import Client``\n- supports Python 3 and Python 2.7\n\n\n\n.. _command-line:\n\nCommand line arguments\n----------------------\n\nThere are few arguments to query Odoo models from the command line.\nAlthough it is quite limited::\n\n    $ erppeek --help\n    Usage: erppeek [options] [search_term_or_id [search_term_or_id ...]]\n\n    Inspect data on Odoo objects.  Use interactively or query a model (-m)\n    and 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: 'erppeek.ini')\n      --server=SERVER       full URL of the server (default: http://localhost:8069/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 allowed)\n      -i, --interact        use interactively; default when no model is queried\n      -v, --verbose         verbose\n    $ #\n\n\nExample::\n\n    $ erppeek -d demo -m res.partner -f name -f lang 1\n    \"name\",\"lang\"\n    \"Your Company\",\"en_US\"\n\n::\n\n    $ erppeek -d demo -m res.groups -f full_name 'id \u003e 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 ``erppeek.ini`` and declare the environment(s)::\n\n    [DEFAULT]\n    scheme = http\n    host = localhost\n    port = 8069\n    database = odoo\n    username = admin\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 /path/to/odoo-server.conf --without-demo all\n\n\nConnect to the Odoo server::\n\n    erppeek --list\n    erppeek --env demo\n\n\nThis is a sample session::\n\n    \u003e\u003e\u003e model('res.users')\n    \u003cModel 'res.users'\u003e\n    \u003e\u003e\u003e model('res.users').count()\n    4\n    \u003e\u003e\u003e model('ir.cron').read(['active = False'], 'active function')\n    [{'active': False, 'function': 'run_mail_scheduler', 'id': 1},\n     {'active': False, 'function': 'run_bdr_scheduler', 'id': 2},\n     {'active': False, 'function': 'scheduled_fetch_new_scans', 'id': 9}]\n    \u003e\u003e\u003e #\n    \u003e\u003e\u003e client.modules('delivery')\n    {'uninstalled': ['delivery', 'sale_delivery_report']}\n    \u003e\u003e\u003e client.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    \u003e\u003e\u003e #\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 ~/.erppeek_history``\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftinyerp%2Ferppeek","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftinyerp%2Ferppeek","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftinyerp%2Ferppeek/lists"}