{"id":13557577,"url":"https://github.com/tryton/proteus","last_synced_at":"2026-01-10T18:33:13.733Z","repository":{"id":8588580,"uuid":"10222362","full_name":"tryton/proteus","owner":"tryton","description":"Mirror of Proteus","archived":true,"fork":false,"pushed_at":"2022-11-18T10:07:30.000Z","size":1109,"stargazers_count":12,"open_issues_count":1,"forks_count":6,"subscribers_count":6,"default_branch":"develop","last_synced_at":"2024-11-04T07:36:07.064Z","etag":null,"topics":["client","library","python","tryton"],"latest_commit_sha":null,"homepage":"https://hg.tryton.org/proteus","language":"Python","has_issues":false,"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/tryton.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG","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":"2013-05-22T14:51:36.000Z","updated_at":"2023-07-31T14:20:37.000Z","dependencies_parsed_at":"2023-01-11T17:25:35.333Z","dependency_job_id":null,"html_url":"https://github.com/tryton/proteus","commit_stats":null,"previous_names":[],"tags_count":166,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tryton%2Fproteus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tryton%2Fproteus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tryton%2Fproteus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tryton%2Fproteus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tryton","download_url":"https://codeload.github.com/tryton/proteus/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246993289,"owners_count":20865975,"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":["client","library","python","tryton"],"created_at":"2024-08-01T12:04:25.715Z","updated_at":"2026-01-10T18:33:13.682Z","avatar_url":"https://github.com/tryton.png","language":"Python","funding_links":[],"categories":["Python","library"],"sub_categories":[],"readme":"=======================\nTryton Scripting Client\n=======================\n\nA library to access Tryton's models like a client.\n\nExample of usage\n----------------\n\n    \u003e\u003e\u003e from proteus import config, Model, Wizard, Report\n\nConfiguration\n~~~~~~~~~~~~~\n\nConfiguration to connect to a sqlite memory database using trytond as module.\n\n    \u003e\u003e\u003e config = config.set_trytond('sqlite:///:memory:')\n\nThere is also the ``config.set_xmlrpc`` method which can be used to connect\nusing a URL, and the ``config.set_xmlrpc_session`` method (when used as a\ncontext manager) which connects for a session.\n\nActivating a module\n~~~~~~~~~~~~~~~~~~~\n\nFind the module, call the activate button and run the upgrade wizard.\n\n    \u003e\u003e\u003e Module = Model.get('ir.module')\n    \u003e\u003e\u003e party_module, = Module.find([('name', '=', 'party')])\n    \u003e\u003e\u003e party_module.click('activate')\n    \u003e\u003e\u003e Wizard('ir.module.activate_upgrade').execute('upgrade')\n\nCreating a party\n~~~~~~~~~~~~~~~~\n\nFirst instantiate a new Party:\n\n    \u003e\u003e\u003e Party = Model.get('party.party')\n    \u003e\u003e\u003e party = Party()\n    \u003e\u003e\u003e party.id \u003c 0\n    True\n\nFill the fields:\n\n    \u003e\u003e\u003e party.name = 'ham'\n\nSave the instance into the server:\n\n    \u003e\u003e\u003e party.save()\n    \u003e\u003e\u003e party.name\n    'ham'\n    \u003e\u003e\u003e party.id \u003e 0\n    True\n\nSetting the language of the party\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nThe language on party is a ``Many2One`` relation field. So it requires to get a\n``Model`` instance as value.\n\n    \u003e\u003e\u003e Lang = Model.get('ir.lang')\n    \u003e\u003e\u003e en, = Lang.find([('code', '=', 'en')])\n    \u003e\u003e\u003e party.lang = en\n    \u003e\u003e\u003e party.save()\n    \u003e\u003e\u003e party.lang.code\n    'en'\n\nCreating an address for the party\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nAddresses are store on party with a ``One2Many`` field.\nSo the new address just needs to be appended to the list ``addresses``.\n\n    \u003e\u003e\u003e address = party.addresses.new(postal_code='42')\n    \u003e\u003e\u003e party.save()\n    \u003e\u003e\u003e party.addresses #doctest: +ELLIPSIS\n    [proteus.Model.get('party.address')(...)]\n\nAdding category to the party\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nCategories are linked to party with a ``Many2Many`` field.\n\nSo first create a category\n\n    \u003e\u003e\u003e Category = Model.get('party.category')\n    \u003e\u003e\u003e category = Category()\n    \u003e\u003e\u003e category.name = 'spam'\n    \u003e\u003e\u003e category.save()\n\nAppend it to categories of the party\n\n    \u003e\u003e\u003e party.categories.append(category)\n    \u003e\u003e\u003e party.save()\n    \u003e\u003e\u003e party.categories #doctest: +ELLIPSIS\n    [proteus.Model.get('party.category')(...)]\n\nPrint party label\n~~~~~~~~~~~~~~~~~\n\nThere is a label report on ``Party``.\n\n    \u003e\u003e\u003e label = Report('party.label')\n\nThe report is executed with a list of records and some extra data.\n\n    \u003e\u003e\u003e type_, data, print_, name = label.execute([party], {})\n\nSorting addresses and register order\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nAddresses are ordered by sequence which means they can be stored following a\nspecific order.\nThe ``set_sequence`` method stores the current order.\n\n    \u003e\u003e\u003e address = party.addresses.new(postal_code='69')\n    \u003e\u003e\u003e party.save()\n    \u003e\u003e\u003e address = party.addresses.new(postal_code='23')\n    \u003e\u003e\u003e party.save()\n\nNow changing the order.\n\n    \u003e\u003e\u003e reversed_addresses = list(reversed(party.addresses))\n    \u003e\u003e\u003e while party.addresses:\n    ...     _ = party.addresses.pop()\n    \u003e\u003e\u003e party.addresses.extend(reversed_addresses)\n    \u003e\u003e\u003e party.addresses.set_sequence()\n    \u003e\u003e\u003e party.save()\n    \u003e\u003e\u003e party.addresses == reversed_addresses\n    True\n\nSetting context\n~~~~~~~~~~~~~~~\n\nMake French translatable:\n\n    \u003e\u003e\u003e Language = Model.get('ir.lang')\n    \u003e\u003e\u003e french, = Language.find([('code', '=', 'fr')])\n    \u003e\u003e\u003e french.translatable = True\n    \u003e\u003e\u003e french.save()\n\nCreate a category in English:\n\n    \u003e\u003e\u003e Category = Model.get('party.category')\n    \u003e\u003e\u003e with config.set_context(language='en'):\n    ...     category = Category(name=\"Category\")\n    ...     category.save()\n\nTranslate in French:\n\n    \u003e\u003e\u003e with config.set_context(language='fr'):\n    ...     category_fr = Category(category.id)\n    ...     category_fr.name = \"Categorie\"\n    ...     category_fr.save()\n\nRead in English:\n\n    \u003e\u003e\u003e category.reload()\n    \u003e\u003e\u003e category.name\n    'Category'\n\nRead in French:\n\n    \u003e\u003e\u003e category_fr.reload()\n    \u003e\u003e\u003e category_fr.name\n    'Categorie'\n\n.. toctree::\n   :maxdepth: 2\n\n   releases\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftryton%2Fproteus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftryton%2Fproteus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftryton%2Fproteus/lists"}