{ "info": { "author": "Rossum developers", "author_email": "support@rossum.ai", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "Intended Audience :: System Administrators", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7" ], "description": "# elisctl\n\n[![PyPI - version](https://img.shields.io/pypi/v/elisctl.svg)](https://pypi.python.org/pypi/elisctl)\n[![Build Status](https://travis-ci.com/rossumai/elisctl.svg?branch=master)](https://travis-ci.com/rossumai/elisctl)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)\n[![codecov](https://codecov.io/gh/rossumai/elisctl/branch/master/graph/badge.svg)](https://codecov.io/gh/rossumai/elisctl)\n![PyPI - supported python versions](https://img.shields.io/pypi/pyversions/elisctl.svg)\n![MIT licence](https://img.shields.io/pypi/l/elisctl.svg)\n\n**elisctl** is a set of [tools for Rossum integrators](https://developers.rossum.ai/) that wrap\nthe [Rossum API](https://api.elis.rossum.ai/docs)\nto provide an easy way to configure and customize a Rossum account - either\ninteractively or programmatically.\n\n## Installation\n\nSee the [elisctl setup tutorial](https://developers.rossum.ai/docs/setting-up-elisctl)\nfor detailed instructions.\n\n### Windows\n\nDownload an installation file from\n[GitHub releases](https://github.com/rossumai/elisctl/releases).\nInstall it. And run it either from start menu or from command prompt.\n\n### UNIX based systems\n\nInstall the package from PyPI:\n```bash\npip install elisctl\n```\n\n## How to use\n\nIndividual Rossum operations are triggered by passing specific *commands* to `elisctl`.\nCommands are organized by object type in a tree-like structure and thus are composed\nof multiple words (e.g. `user create` or `schema transform`).\n\nThe **elisctl** tool can be either used in a **command line interface** mode\nby executing each command through `elisctl` individually by passing it as an argument,\nor in an **interactive shell** mode of executing `elisctl` without parameters\nand then typing the commands into the shown prompt.\n\nSo either get the list of commands and execute them immediately such as:\n```shell\nelisctl --help\nelisctl configure\n```\nor run the interactive shell by simply running\n```shell\nelisctl\n```\n## Configure profiles\n\nTo run commands described below under a chosen user, it is possible to use profiles defined by\nconfigure function such as\n```shell\nelisctl --profile profile_name configure\n```\n\nAfter defining necessary profiles and their credentials, the profile can be chosen the following way\n```shell\nelisctl --profile profile_name queue list\n```\n\n## Edit Schema\n\nSome of the most common advanced operations are related to setting up\nthe sidebar-describing schema according to business requirements. Using elisctl\nyou can edit schema easily as a JSON file.\n\nList queues to obtain schema id:\n```shell\nelisctl queue list\n id name workspace inbox schema users\n---- --------------------------- ----------- ---------------------------------------- -------- ----------------------\n 6 My Queue 1 6 myqueue-ab12ee@elis.rossum.ai 7 27\n```\n\nDownload schema as a json:\n```shell\nelisctl schema get 7 -O schema.json\n```\n\nOpen the `schema.json` file in you favourite editor and upload modified version back to Rossum.\n```shell\nelisctl schema update 7 schema.json\n```\n\nFrom now on, documents will follow new schema. (Warning! The new schema\nreceives a new id - obtain it by `queue list` again.)\n\nAs an experimental feature, you can also edit schema as an Excel (xlsx) file.\n```shell\nelisctl schema get 7 --format xlsx -O schema.xlsx\nelisctl schema update 7 schema.xlsx\n```\n\n\n## Schema Transformations\n\nIn addition, there is a scripting support for many common schema operations,\nthat may be easily used for schema management automation. See `elisctl schema transform`\nand `elisctl tools` tools for further reference.\n\nRun something like:\n```shell\nelisctl schema transform substitute-options default_schema.json centre <( \\\n elisctl tools xls_to_csv ~/Downloads/ERA_osnova_strediska.xlsx --header 0 --sheet 1 | elisctl tools csv_to_options - ) \\\n | elisctl schema transform substitute-options - gl_code <( \\\n elisctl tools xls_to_csv ~/Downloads/ERA_osnova_strediska.xlsx --header 0 | elisctl tools csv_to_options - ) \\\n | elisctl schema transform remove - contract \\\n > era_schema.json\n```\n\n## License\nMIT\n\n## Contributing\n\n* Submit a pull request from forked version of this repo. \nAnd select any of the maintainers as a reviewer.\n* Use [`pre-commit`](https://pre-commit.com/#install) to avoid linting issues.\n* When releasing, a `Collaborator` with `Admin` role shall run in `master` branch:\n ```bash\n bump2version minor\n git push\n git push --tags\n ``` \n * To build a Windows installer, run:\n ```bash\n pynsist installer.cfg\n ``` \n \n## Changelog\n\n### 2019-08-13 v2.7.0\n* Add command `user_assignment` for bulk assignment of users to queues\n* Change command `connector create`: `queue_id` parameter needs to be specified, if there is more than one queue in organization\n* Support schema attribute `width` in XLSX schema format\n* Fixed: booleans, in XLSX schema format, can be specified as boolean types\n* Internal: filename can be specified in `ELISClient.upload_document`\n\n\n### 2019-07-30 v2.6.0\n* Enable passing custom filename with upload\n\n### 2019-07-12 v2.5.0\n\n* Add support for schema specified in XLSX when creating queue\n* Remove the necessity to specify schema file type when uploading\n* Fix XML and CSV formats of `elisctl document extract`\n\n### 2019-07-09 v2.4.0\n\n* Add support for can_export in xlsx schema format\n* Add document command\n\n### 2019-06-21 v2.3.1\n\n* Fix: annotator cannot use `elisctl connector list` command\n\n### 2019-06-13 v2.3.0\n\n* Add connector command\n\n### 2019-06-11 v2.2.1\n\n* Update packages for windows build.\n\n\n### 2019-06-03 v2.2.0\n\n* Added support for [`--profile`](#configure-profiles) option to all `elisctl` commands\n* Fix: remove extra whitespace in xlsx schema export/import\n\n### 2019-04-02 v2.1.0\n\n* Added support for `--output-file` to `elisctl tools` and `elisctl schema transform`\n* Fix [Schema Transformations](#schema-transformations) description in README\n\n### 2019-03-14 v2.0.1\n\n* Fixed MS Windows application entry point (running elisctl from the start menu)\n* Fixed parsing of boolean values in xlsx schema export/import\n\n### 2019-03-14 v2.0.0\n\n* Disable interpolation in config parsing, so that special characters are allowed in e.g. password\n* Experimental support for schema modification using xlsx file format\n* Allow to show help in schema transform add (backward incompatible change)\n\n### 2019-03-08 v1.1.1\n\n* Fixed bug with UnicodeDecodeError in `elisctl schema get ID -O file.json` on Windows\n\n### 2019-03-03 v1.1.0\n\n* Added support for python 3.6\n* Added `User-Agent` header (`elisctl/{version} ({platform})`) for every request to ELIS API\n* Improved error when login fails with the provided credentials", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://developers.rossum.ai/", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "elisctl", "package_url": "https://pypi.org/project/elisctl/", "platform": "", "project_url": "https://pypi.org/project/elisctl/", "project_urls": { "Homepage": "https://developers.rossum.ai/", "Source": "https://github.com/rossumai/elisctl", "Tracker": "https://github.com/rossumai/elisctl/issues" }, "release_url": "https://pypi.org/project/elisctl/2.7.1/", "requires_dist": null, "requires_python": ">=3.6", "summary": "Command line interface for controlling the Rossum platform", "version": "2.7.1" }, "last_serial": 5905573, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "f1fdb8d7f280ecdb106670cf04fb40a7", "sha256": "849213da6a2c8c12d5695debba9db59372b50829c613387caa9a405b94573223" }, "downloads": -1, "filename": "elisctl-1.0.0.tar.gz", "has_sig": false, "md5_digest": "f1fdb8d7f280ecdb106670cf04fb40a7", "packagetype": "sdist", "python_version": "source", "requires_python": "~=3.7", "size": 17199, "upload_time": "2019-02-12T12:06:49", "url": "https://files.pythonhosted.org/packages/86/47/338586fb1603c0196b849ca51fdc2e1766a23fd1a4e54546c587b5daa062/elisctl-1.0.0.tar.gz" } ], "1.1.0": [ { "comment_text": "", "digests": { "md5": "5f9fb6e0e6b56e40a81fec758399db0e", "sha256": "bce5da2e30bfd35cb5617be9157ae375eed84c455eca299bd8c7e2d1bc9fd841" }, "downloads": -1, "filename": "elisctl-1.1.0.tar.gz", "has_sig": false, "md5_digest": "5f9fb6e0e6b56e40a81fec758399db0e", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 17434, "upload_time": "2019-03-03T21:21:45", "url": "https://files.pythonhosted.org/packages/2f/99/8ad59901ab36c144f7da3346ae9db9a8b36f259e76354bb9a0012aca29bf/elisctl-1.1.0.tar.gz" } ], "1.1.1": [ { "comment_text": "", "digests": { "md5": "1d9a02116b8abe75f4ace00e3127459e", "sha256": "4e5af2e7e31e52cbedef9107bd7fc102ed5392563bbfbbdc145621bbdfda9b2c" }, "downloads": -1, "filename": "elisctl-1.1.1.tar.gz", "has_sig": false, "md5_digest": "1d9a02116b8abe75f4ace00e3127459e", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 17659, "upload_time": "2019-03-08T18:11:23", "url": "https://files.pythonhosted.org/packages/1d/76/505da1df642e3cd80f6481965a5502961baa64e8771dd59e639bcdc3599b/elisctl-1.1.1.tar.gz" } ], "2.0.0": [ { "comment_text": "", "digests": { "md5": "298917aa1ea9a1908be6e27a50eb32eb", "sha256": "21f54c5c0862f45dc3435edbe73b0f4a999048ed959e1e0a137ae4be9b038451" }, "downloads": -1, "filename": "elisctl-2.0.0.tar.gz", "has_sig": false, "md5_digest": "298917aa1ea9a1908be6e27a50eb32eb", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 21502, "upload_time": "2019-03-14T08:17:41", "url": "https://files.pythonhosted.org/packages/b9/9e/b25e64b4b50d79b0cda3d2dd8ca956ff80b5c8ed82bc644bc6e8dbab69f8/elisctl-2.0.0.tar.gz" } ], "2.0.1": [ { "comment_text": "", "digests": { "md5": "597e9c33da2a255e99065ae8af783f19", "sha256": "d16f0d0e4cf79984db1cb65e9bd2d265721a8bb575819c7441474ea3ef5ea9b1" }, "downloads": -1, "filename": "elisctl-2.0.1.tar.gz", "has_sig": false, "md5_digest": "597e9c33da2a255e99065ae8af783f19", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 21712, "upload_time": "2019-03-14T14:08:03", "url": "https://files.pythonhosted.org/packages/2e/bc/a29f0d3a01cc4455558bf58fd2ca7df58ebc3099694e019bd62ab9d73aad/elisctl-2.0.1.tar.gz" } ], "2.1.0": [ { "comment_text": "", "digests": { "md5": "749a8a5532a2ab45746322989f8ebd65", "sha256": "eac31c0d81c3f5ceac1a4a0fff328161391b0c131af71f5172aad187689d4e4b" }, "downloads": -1, "filename": "elisctl-2.1.0.tar.gz", "has_sig": false, "md5_digest": "749a8a5532a2ab45746322989f8ebd65", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 21959, "upload_time": "2019-04-02T12:57:07", "url": "https://files.pythonhosted.org/packages/18/d2/bef6d2217a69cc73b2be47880fb5004afdd974b249e83e8cc1c565a6f593/elisctl-2.1.0.tar.gz" } ], "2.2.0": [ { "comment_text": "", "digests": { "md5": "4828260c3d09aed361cc624b1c6acb11", "sha256": "cf72d15d2fbf0f792f8dfca2998cd66ec7e40b849283db401e452c405fb2631c" }, "downloads": -1, "filename": "elisctl-2.2.0.tar.gz", "has_sig": false, "md5_digest": "4828260c3d09aed361cc624b1c6acb11", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 22357, "upload_time": "2019-06-03T13:17:42", "url": "https://files.pythonhosted.org/packages/d7/c5/330b6d135434513f8f26de8c1097b2e5ee8ad1e511372a243b0b52d75746/elisctl-2.2.0.tar.gz" } ], "2.2.1": [ { "comment_text": "", "digests": { "md5": "1703ae0975b17f3a0c89389d2db44187", "sha256": "440293d5065fa82b2aaef9b91d98f9cef9a551c71222cbde5bbbd173efa75e74" }, "downloads": -1, "filename": "elisctl-2.2.1.tar.gz", "has_sig": false, "md5_digest": "1703ae0975b17f3a0c89389d2db44187", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 22517, "upload_time": "2019-06-11T11:40:45", "url": "https://files.pythonhosted.org/packages/cc/33/81c2fb983ab04cae7558da2929debd5cc45dfdb41f98e6c87bd0e0055552/elisctl-2.2.1.tar.gz" } ], "2.3.0": [ { "comment_text": "", "digests": { "md5": "309161d31c597532e839c816d7a6cedf", "sha256": "446d98bbc23e8e4784f5bc89f343015d8d9728c0c155fdad37e1a1800bd4bb67" }, "downloads": -1, "filename": "elisctl-2.3.0.tar.gz", "has_sig": false, "md5_digest": "309161d31c597532e839c816d7a6cedf", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 23419, "upload_time": "2019-06-13T13:13:18", "url": "https://files.pythonhosted.org/packages/85/59/6eed21be2d15e81b44912c41700e5dd91ed6f2cb375457d054b4b43da3ed/elisctl-2.3.0.tar.gz" } ], "2.3.1": [ { "comment_text": "", "digests": { "md5": "1a240979753011753f106a17227bddf0", "sha256": "ed01a3cbff25cd53a6da33b9b25d148428c40219db16216c6171e91d16227e9a" }, "downloads": -1, "filename": "elisctl-2.3.1.tar.gz", "has_sig": false, "md5_digest": "1a240979753011753f106a17227bddf0", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 23530, "upload_time": "2019-06-21T08:27:22", "url": "https://files.pythonhosted.org/packages/fb/33/975d3f93db8a4f265ed5eb5e77650cbfe8cd42c5f6c58110585628d6d01d/elisctl-2.3.1.tar.gz" } ], "2.4.0": [ { "comment_text": "", "digests": { "md5": "f69c73862c9dc5fb9af7b82e3dfa9aca", "sha256": "473ebc40d178463013c50ad395916f072e07b1bcbe96f85108e32186ac87fe70" }, "downloads": -1, "filename": "elisctl-2.4.0.tar.gz", "has_sig": false, "md5_digest": "f69c73862c9dc5fb9af7b82e3dfa9aca", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 25159, "upload_time": "2019-07-09T12:03:41", "url": "https://files.pythonhosted.org/packages/ab/2e/2b1c01cd4f2e92cbd6858474b825ea6dfb662739c76bc83bff8c61eda4d4/elisctl-2.4.0.tar.gz" } ], "2.5.0": [ { "comment_text": "", "digests": { "md5": "504e6141bc50a167d854fbff1b8f509d", "sha256": "d33435b3c3d96804e010b8d05787bd639bde5558ed38b5341c8334cd1bf3999f" }, "downloads": -1, "filename": "elisctl-2.5.0.tar.gz", "has_sig": false, "md5_digest": "504e6141bc50a167d854fbff1b8f509d", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 26050, "upload_time": "2019-07-12T13:20:41", "url": "https://files.pythonhosted.org/packages/61/91/4e0727cba84830e5eee3142ef1d65cae4c628b15382730ac55e7ea2ef41b/elisctl-2.5.0.tar.gz" } ], "2.6.0": [ { "comment_text": "", "digests": { "md5": "136e0e941e09488866b93304d1bc4e0f", "sha256": "55ed92c75fba20010756c712943d79fdbb49955a46b53bb52ea24fb2c0b3f28d" }, "downloads": -1, "filename": "elisctl-2.6.0.tar.gz", "has_sig": false, "md5_digest": "136e0e941e09488866b93304d1bc4e0f", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 26301, "upload_time": "2019-07-31T07:39:21", "url": "https://files.pythonhosted.org/packages/17/de/8e5388bbc5003caee7e419d5131381b638696c758a7e42f54df0c74809e0/elisctl-2.6.0.tar.gz" } ], "2.7.0": [ { "comment_text": "", "digests": { "md5": "d9017fc2ed3c987d9e99a22583144c5d", "sha256": "42d7b9718aa83ccd48bde21f7e5db28b9047b4d06b732e4cf78c6ed9f790c40b" }, "downloads": -1, "filename": "elisctl-2.7.0.tar.gz", "has_sig": false, "md5_digest": "d9017fc2ed3c987d9e99a22583144c5d", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 27216, "upload_time": "2019-08-13T12:39:20", "url": "https://files.pythonhosted.org/packages/f7/66/09e9c0c005846294468897d21af9faa486a4d7d8eddc52559738a0b8bdd4/elisctl-2.7.0.tar.gz" } ], "2.7.1": [ { "comment_text": "", "digests": { "md5": "96f8a12f2f4a08d407bf880f468ecb3b", "sha256": "67e85f51183d588514bece1b7da8e721ae6a681b5099c6840409b2a3dfc9b7d7" }, "downloads": -1, "filename": "elisctl-2.7.1.tar.gz", "has_sig": false, "md5_digest": "96f8a12f2f4a08d407bf880f468ecb3b", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 27795, "upload_time": "2019-09-30T08:44:37", "url": "https://files.pythonhosted.org/packages/e3/c1/0216e36a996a52b40e0a8babb53ca10b270930c0f408a87ce79be1a8617b/elisctl-2.7.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "96f8a12f2f4a08d407bf880f468ecb3b", "sha256": "67e85f51183d588514bece1b7da8e721ae6a681b5099c6840409b2a3dfc9b7d7" }, "downloads": -1, "filename": "elisctl-2.7.1.tar.gz", "has_sig": false, "md5_digest": "96f8a12f2f4a08d407bf880f468ecb3b", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 27795, "upload_time": "2019-09-30T08:44:37", "url": "https://files.pythonhosted.org/packages/e3/c1/0216e36a996a52b40e0a8babb53ca10b270930c0f408a87ce79be1a8617b/elisctl-2.7.1.tar.gz" } ] }