Skip to content
This repository has been archived by the owner on Sep 25, 2024. It is now read-only.

Commit

Permalink
Merge pull request #88 from rossumai/enhancement/developer-portal
Browse files Browse the repository at this point in the history
README enhancement: Refer the developer portal
  • Loading branch information
Kryštof Pilnáček authored Sep 30, 2019
2 parents ef45d0b + 62e6ec2 commit 6870912
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 10 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,22 @@
![PyPI - supported python versions](https://img.shields.io/pypi/pyversions/elisctl.svg)
![MIT licence](https://img.shields.io/pypi/l/elisctl.svg)

**elisctl** is a set of tools that wrap
the [Elis Document Management API](https://api.elis.rossum.ai/docs)
to provide an easy way to configure, integrate and customize Elis - either
**elisctl** is a set of [tools for Rossum integrators](https://developers.rossum.ai/) that wrap
the [Rossum API](https://api.elis.rossum.ai/docs)
to provide an easy way to configure and customize a Rossum account - either
interactively or programmatically.

## Installation

See the [elisctl setup tutorial](https://developers.rossum.ai/docs/setting-up-elisctl)
for detailed instructions.

### Windows

Download an installation file from
[GitHub releases](https://github.com/rossumai/elisctl/releases).
Install it. And run it either from start menu or from command prompt.


### UNIX based systems

Install the package from PyPI:
Expand All @@ -30,7 +32,7 @@ pip install elisctl

## How to use

Individual Elis operation are triggered by passing specific *commands* to `elisctl`.
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`).

Expand Down Expand Up @@ -80,12 +82,13 @@ Download schema as a json:
elisctl schema get 7 -O schema.json
```

Open `schema.json` file in you favourite editor and upload modified version back to Elis.
Open the `schema.json` file in you favourite editor and upload modified version back to Rossum.
```shell
elisctl schema update 7 schema.json
```

From now on, documents will follow new schema.
From now on, documents will follow new schema. (Warning! The new schema
receives a new id - obtain it by `queue list` again.)

As an experimental feature, you can also edit schema as an Excel (xlsx) file.
```shell
Expand Down
6 changes: 3 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
setup(
name="elisctl",
version="2.7.0",
description="Command line interface for controlling ELIS",
description="Command line interface for controlling the Rossum platform",
long_description=open("README.md").read(),
long_description_content_type="text/markdown",
url="https://rossum.ai/data-capture",
author="ELIS authors",
url="https://developers.rossum.ai/",
author="Rossum developers",
author_email="[email protected]",
license="MIT",
project_urls={
Expand Down

0 comments on commit 6870912

Please sign in to comment.