The elisctl package has been renamed to rossum.
You may want to uninstall elisctl before installing rossum.
📝 Consider substituting rossum in your project with the more up-to-date rossum-sdk library.
rossum 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 programmatically. It is the best buddy when it comes to making requests to Rossum API.
See the rossum setup tutorial for detailed instructions.
Download an installation file from GitHub releases. Install it. And run it either from start menu or from command prompt.
Install the package from PyPI:
pip install rossumThe rossum library can be used to communicate with Rossum API,
instead of using requests library directly. The advantages of using rossum:
- 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,
- it includes many methods for frequent actions that you don't need to write by yourself from scratch,
- it includes configurable retry logic,
- in case the API version changes, the change will be implemented to the library by Rossum for all the users.
To make any request to Rossum API, use RossumClient() class wrapper. You can use a Rossum
token to log in or use username and password. You need to either pass the credentials
including the URL directly to the client, or set ROSSUM_URL envvar and either a token
or ROSSUM_USERNAME and ROSSUM_PASSWORD envvars in your code. See the sample script
using rossum within a code to export the documents:
import datetime
from rossum.lib.api_client import RossumClient
queue_id = 123456
username = "your_username"
password = "your_password"
endpoint = "https://api.elis.rossum.ai/v1"
def export_documents():
with RossumClient(context=None, user=username, password=password, url=endpoint) as client:
date_today = datetime.date.today()
date_end = date_today
date_start = date_today - datetime.timedelta(days=1)
response = client.get(
f"queues/{queue_id}/export?format=xml&"
f"exported_at_after={date_start.isoformat()}&"
f"exported_at_before={date_end.isoformat()}&"
f"ordering=exported_at&"
f"page_size=100&page=1"
)
if not response.ok:
raise ValueError(f"Failed to export: {response.status_code}")
if __name__ == "__main__":
export_documents()
⚠️ CLI functionality is not actively developed anymore.
The rossum tool can be either used in a command line interface mode
by executing each command through rossum individually by passing it as an argument,
or in an interactive shell mode of executing rossum without parameters
and then typing the commands into the shown prompt.
Individual Rossum operations are triggered by passing specific commands to rossum.
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:
rossum --help
rossum configureor run the interactive shell by simply running
rossumSee the sample using rossum command line tool to create the main objects within an organization and
assign a user to a queue:
$ rossum configure
API URL [https://api.elis.rossum.ai]:
Username: your_username@company.com
Password:
$ rossum workspace create "My New Workspace"
12345
$ rossum queue create "My New Queue Via rossum" -s schema.json -w 12345 --email-prefix my-queue-email --bounce-email bounced-docs-here@company.com
50117, my-queue-email-ccddc6@elis.rossum.ai
$ rossum user create john.doe@company.com -q 50117 -g annotator -p my-secret-password-154568
59119, my-secret-password-154568
$ rossum user_assignment add -u 59119 -q 50117To run commands described below under a chosen user, it is possible to use profiles defined by configure function such as
rossum --profile profile_name configureAfter defining necessary profiles and their credentials, the profile can be chosen the following way
rossum --profile profile_name queue listSome of the most common advanced operations are related to setting up the sidebar-describing schema according to business requirements. Using rossum you can edit schema easily as a JSON or XLSX file.
List queues to obtain schema id:
$ rossum queue list
id name workspace inbox schema users
---- --------------------------- ----------- ---------------------------------------- -------- ----------------------
6 My Queue 1 6 myqueue-ab12ee@elis.rossum.ai 7 27Download schema as a json:
rossum schema get 7 -O schema.jsonOpen the schema.json file in you favourite editor and upload modified version back to Rossum.
rossum schema update 7 --rewrite schema.jsonYou can also edit schema as an Excel (xlsx) file.
rossum schema get 7 --format xlsx -O schema.xlsx
rossum schema update 7 --rewrite schema.xlsxFrom 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.)
In addition, there is a scripting support for many common schema operations,
that may be easily used for schema management automation. See rossum schema transform
and rossum tools tools for further reference.
Run something like:
$ rossum schema transform substitute-options default_schema.json centre <( \
rossum tools xls_to_csv ~/Downloads/ERA_osnova_strediska.xlsx --header 0 --sheet 1 | rossum tools csv_to_options - ) \
| rossum schema transform substitute-options - gl_code <( \
rossum tools xls_to_csv ~/Downloads/ERA_osnova_strediska.xlsx --header 0 | rossum tools csv_to_options - ) \
| rossum schema transform remove - contract \
> era_schema.jsonMIT
-
Use
pre-committo 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
CollaboratorwithAdminrole shall do the following inmasterbranch:-
Update the Changelog in README, describing all the changes included in the newest release
-
run:
bump2version minor git push git push --tags
-
-
In the end, to build a Windows installer, run:
pynsist installer.cfg
-
Go to releases and upload the newest .exe file from the
.buildfolder of yourrossumrepository to the newest release
- Fix: Fix type error from click
- Fix: Substitute obsolete click function
- Fix: Pin openpyxl dependency to a specific version due to this issue
- Pin openpyxl dependency to allow using Rossum CLI
- Allow using click>8.0.0
- feat(.gitignore): ignore vscode
- feat(api_client): add email param for user creation
- feat(tox) add py39 test env
- ref(README) format file by linter
- build(pre-commit) update versions
- Ensure compatibility with click<8.1.0
- Update setup of the release process for pypi
- Add method for getting annotations
- Refactor sideloading functionality to enable sideloading of new objects
- Add sideloading option for get_paginated() method
- Propagate changelogs to the releases
- Allow sending new attributes to API when creating hooks
- Response is being propagated to the RossumException
- Added functions to iterate over hook payload easily
- Fix for library versioning due to incorrectly published tags
- Allow creation of inbox without passing bounce email
- Allow uploading documents by passing file as bytes to the API client
- Include tenacity library in the Windows build
- Allow filtering specific queue IDs when listing all user's queues
- Allow passing token_owner, test and run_after attributes when creating and changing hook objects
- Applied configurable retry mechanism to all requests done via rossum library
- Enable assigning annotator_limited role to user
- Allow setting rir_params for queues
- Allow setting custom timeout for APIClient requests
- Use openpyxl engine for xlsx files reading
- Apply minor code optimalization fixes
- Create password command
- Allow passing parameters when listing hooks
- Fix passing metadata when creating a workspace
- Remove Obsoletes-Dist
- Enable creating serverless functions
- Add method for creating workspaces
- Allow setting up sideloading on hooks
- Refactor _request_url() to allow custom logging
- Fix missing library in setup.py
- Remove references to old package names
- Update
setup.py
- elisctl was renamed to rossum
- Fix attribute name for setting max token lifetime
- Add
schema listcommand - Fix
webhook changecommand issue - Remove
csv getcommand - Add example script for setting up a new organisation
- Enable assigning manager role to user
- Enable setting max token lifetime
- Catch ValueError when parsing schema in XLSX
- Fix Python3.8 support
- allow editing inbox attributes separately on queue-related commands
- add support for
can_collapsein xlsx schema - add sample usage of elisctl library in a Python code
- make queue option required on
user create
- Add webhook command
- Allow creating and changing inbox properties on
queue changecommand
- Improve documentation
- Add command
user_assignmentfor bulk assignment of users to queues - Change command
connector create:queue_idparameter needs to be specified, if there is more than one queue in organization - Support schema attribute
widthin XLSX schema format - Fixed: booleans, in XLSX schema format, can be specified as boolean types
- Internal: filename can be specified in
ELISClient.upload_document
- Enable passing custom filename with upload
- 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
- Add support for can_export in xlsx schema format
- Add document command
- Fix: annotator cannot use
elisctl connector listcommand
- Add connector command
- Update packages for windows build.
- Added support for
--profileoption to allelisctlcommands - Fix: remove extra whitespace in xlsx schema export/import
- Added support for
--output-filetoelisctl toolsandelisctl schema transform - Fix Schema Transformations description in README
- Fixed MS Windows application entry point (running elisctl from the start menu)
- Fixed parsing of boolean values in xlsx schema export/import
- 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)
- Fixed bug with UnicodeDecodeError in
elisctl schema get ID -O file.jsonon Windows
- Added support for python 3.6
- Added
User-Agentheader (elisctl/{version} ({platform})) for every request to ROSSUM API - Improved error when login fails with the provided credentials