opencultureconsulting
/
orcli
mirror of https://github.com/opencultureconsulting/orcli.git
2
0
Fork 0
Code Issues Releases Activity

elaborate on features and requirements

This commit is contained in:
Felix Lohmeier 2022-04-20 10:08:05 +02:00 committed by GitHub
parent 3e6fb6a1d7
commit a2b921895b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -5,18 +5,23 @@ Bash script to control OpenRefine via [its HTTP API](https://docs.openrefine.org
## Features ## Features
* works with latest OpenRefine version (currently 3.5) * works with latest OpenRefine version (currently 3.5)
* nested sub-commands with help screens and usage examples * batch processing (import, transform, export)
* batch processing (import, transform, export) with temporary workspaces; your existing OpenRefine data will not be touched * orcli takes care of starting and stopping OpenRefine with temporary workspaces
* your existing OpenRefine data will not be touched
* import CSV, ~~TSV, line-based TXT, fixed-width TXT, JSON or XML~~ (and specify input options) * import CSV, ~~TSV, line-based TXT, fixed-width TXT, JSON or XML~~ (and specify input options)
* transform data by providing an [undo/redo](https://docs.openrefine.org/manual/running#history-undoredo) JSON file; orcli calls specific endpoints for each operation to provide improved error handling and logging * supports stdin, multiple files and URLs
* transform data by providing an [undo/redo](https://docs.openrefine.org/manual/running#history-undoredo) JSON file
* orcli calls specific endpoints for each operation to provide improved error handling and logging
* supports stdin, multiple files and URLs
* export to TSV, ~~CSV, HTML, XLS, XLSX, ODS~~ * export to TSV, ~~CSV, HTML, XLS, XLSX, ODS~~
* ~~[templating export](https://docs.openrefine.org/manual/exporting#templating-exporter) to additional formats like JSON or XML~~ * ~~[templating export](https://docs.openrefine.org/manual/exporting#templating-exporter) to additional formats like JSON or XML~~
## Requirements ## Requirements
* GNU/Linux with Bash * GNU/Linux with Bash 4+
* [jq](https://stedolan.github.io/jq/) * [jq](https://stedolan.github.io/jq)
* [curl](https://curl.se/) * [curl](https://curl.se)
* [OpenRefine](https://openrefine.org) 😉
## Install ## Install