Skip to content
Command line interface for controlling ELIS
Python
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
elisctl
tests Require queue on user create Jan 6, 2020
.bumpversion.cfg
.flake8
.gitignore
.gitlab-ci.yml
.pre-commit-config.yaml
.travis.yml
LICENSE
README.md
installer.cfg
pyproject.toml
setup.cfg Add CI pipeline Jan 23, 2019
setup.py
tox.ini

README.md

elisctl

PyPI - version Build Status Code style: black codecov PyPI - supported python versions MIT licence

elisctl is a set of tools for Rossum integrators that wrap the Rossum API to provide an easy way to configure and customize a Rossum account - either interactively or programmatically.

Installation

See the elisctl setup tutorial for detailed instructions.

Windows

Download an installation file from GitHub releases. Install it. And run it either from start menu or from command prompt.

UNIX based systems

Install the package from PyPI:

pip install elisctl

Usage

Python API Client Library

The elisctl library can be used to communicate with Rossum API, instead of using requests library directly. The advantages of using elisctl:

  • it contains a function that merges the paginated results into one list so the user does not need to get results page by page and take care of their merging,
  • it takes care of login and logout for the user,
  • in case the API version changes, the change will be implemented to the library by Rossum for all the users.

See the sample script using elisctl within a code to export the documents:

import json
import logging

from elisctl.lib.api_client import APIClient
from datetime import date, timedelta

queue_id = 12673
username = 'your_username'
password = 'your_password'
reviewed_documents = "exported,exporting,failed_export"

# This example downloads data for documents exported during the previous calendar day.
date_today = date.today()
date_end = date_today
date_start = date_today - timedelta(days=1)

def export_documents():
    logging.info("Export started...")
    with APIClient(context=None, user=username, password=password) as rossum:

            annotations_list, _ = rossum.get_paginated(f"queues/{queue_id}/export",
                                                        {"status": reviewed_documents,
                                                        "format": "json",
                                                        "ordering": "exported_at",
                                                        "exported_at_after": date_start.isoformat(),
                                                        "exported_at_before": date_end.isoformat()})

            with open('data.json', 'w') as f:
                json.dump(annotations_list, f)
    logging.info("...export finished.")

if __name__ == "__main__":
    export_documents()

API Client command line tool

The elisctl tool can be either used in a command line interface mode by executing each command through elisctl individually by passing it as an argument, or in an interactive shell mode of executing elisctl without parameters and then typing the commands into the shown prompt.

Individual Rossum operations are triggered by passing specific commands to elisctl. Commands are organized by object type in a tree-like structure and thus are composed of multiple words (e.g. user create or schema transform).

So either get the list of commands and execute them immediately such as:

elisctl --help
elisctl configure

or run the interactive shell by simply running

elisctl

Configure profiles

To run commands described below under a chosen user, it is possible to use profiles defined by configure function such as

elisctl --profile profile_name configure

After defining necessary profiles and their credentials, the profile can be chosen the following way

elisctl --profile profile_name queue list

Edit Schema

Some of the most common advanced operations are related to setting up the sidebar-describing schema according to business requirements. Using elisctl you can edit schema easily as a JSON or XLSX file.

List queues to obtain schema id:

elisctl queue list
  id  name                           workspace  inbox                                       schema  users
----  ---------------------------  -----------  ----------------------------------------  --------  ----------------------
   6  My Queue 1                             6  myqueue-ab12ee@elis.rossum.ai                    7  27

Download schema as a json:

elisctl schema get 7 -O schema.json

Open the schema.json file in you favourite editor and upload modified version back to Rossum.

elisctl schema update 7 --rewrite schema.json

You can also edit schema as an Excel (xlsx) file.

elisctl schema get 7 --format xlsx -O schema.xlsx
elisctl schema update 7 --rewrite schema.xlsx

From now on, documents will follow new schema. (Warning! If you don't use --rewrite option, the new schema will receive a new id - obtain it by queue list again.)

Schema Transformations

In addition, there is a scripting support for many common schema operations, that may be easily used for schema management automation. See elisctl schema transform and elisctl tools tools for further reference.

Run something like:

elisctl schema transform substitute-options default_schema.json centre <( \
   elisctl tools xls_to_csv ~/Downloads/ERA_osnova_strediska.xlsx --header 0 --sheet 1 | elisctl tools csv_to_options - ) \
 | elisctl schema transform substitute-options - gl_code <( \
    elisctl tools xls_to_csv ~/Downloads/ERA_osnova_strediska.xlsx --header 0 | elisctl tools csv_to_options - ) \
 | elisctl schema transform remove - contract \
 > era_schema.json

License

MIT

Contributing

  • Use pre-commit to avoid linting issues.
  • Submit a pull request from forked version of this repo.
  • Select any of the maintainers as a reviewer.
  • After an approved review, when releasing, a Collaborator with Admin role shall run in master branch:
    bump2version minor
    git push
    git push --tags
  • To build a Windows installer, run:
    pynsist installer.cfg

Changelog

2019-10-31 v2.8.0

  • Add webhook command
  • Allow creating and changing inbox properties on queue change command

2019-09-30 v2.7.1

  • Improve documentation

2019-08-13 v2.7.0

  • Add command user_assignment for bulk assignment of users to queues
  • Change command connector create: queue_id parameter needs to be specified, if there is more than one queue in organization
  • Support schema attribute width in XLSX schema format
  • Fixed: booleans, in XLSX schema format, can be specified as boolean types
  • Internal: filename can be specified in ELISClient.upload_document

2019-07-30 v2.6.0

  • Enable passing custom filename with upload

2019-07-12 v2.5.0

  • Add support for schema specified in XLSX when creating queue
  • Remove the necessity to specify schema file type when uploading
  • Fix XML and CSV formats of elisctl document extract

2019-07-09 v2.4.0

  • Add support for can_export in xlsx schema format
  • Add document command

2019-06-21 v2.3.1

  • Fix: annotator cannot use elisctl connector list command

2019-06-13 v2.3.0

  • Add connector command

2019-06-11 v2.2.1

  • Update packages for windows build.

2019-06-03 v2.2.0

  • Added support for --profile option to all elisctl commands
  • Fix: remove extra whitespace in xlsx schema export/import

2019-04-02 v2.1.0

  • Added support for --output-file to elisctl tools and elisctl schema transform
  • Fix Schema Transformations description in README

2019-03-14 v2.0.1

  • Fixed MS Windows application entry point (running elisctl from the start menu)
  • Fixed parsing of boolean values in xlsx schema export/import

2019-03-14 v2.0.0

  • Disable interpolation in config parsing, so that special characters are allowed in e.g. password
  • Experimental support for schema modification using xlsx file format
  • Allow to show help in schema transform add (backward incompatible change)

2019-03-08 v1.1.1

  • Fixed bug with UnicodeDecodeError in elisctl schema get ID -O file.json on Windows

2019-03-03 v1.1.0

  • Added support for python 3.6
  • Added User-Agent header (elisctl/{version} ({platform})) for every request to ELIS API
  • Improved error when login fails with the provided credentials
You can’t perform that action at this time.