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

set goals for 0.2.0 milestone

This commit is contained in:
Felix Lohmeier 2022-04-04 23:00:37 +02:00
parent 1af14125a5
commit 909deadf46
3 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -5,12 +5,12 @@ 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)
* provides nested sub-commands with help screens and usage examples * nested sub-commands with help screens and usage examples
* supports batch processing (import, transform, export) with dedicated OpenRefine instances * batch processing (import, transform, export) 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 either by directly calling operations or by providing a [undo/redo](https://docs.openrefine.org/manual/running#history-undoredo) JSON file * 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
* export to CSV, TSV, HTML, XLS, XLSX, ODS * export to ~~CSV,~~ TSV~~, 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
@ -42,7 +42,7 @@ Ensure you have OpenRefine running (i.e. available at http://localhost:3333 or a
Use integrated help screens for available options and examples for each command. Use integrated help screens for available options and examples for each command.
```sh ```sh
[felix@tux orcli]$ ./orcli --help $ orcli --help
orcli - OpenRefine command-line interface written in Bash orcli - OpenRefine command-line interface written in Bash
Usage: Usage:
@ -74,6 +74,8 @@ Examples:
orcli list orcli list
orcli info clipboard orcli info clipboard
orcli info 1234567890123 orcli info 1234567890123
https://github.com/opencultureconsulting/orcli
``` ```
## Development ## Development

3
orcli
View File

@ -69,6 +69,9 @@ orcli_usage() {
printf " orcli info clipboard\n" printf " orcli info clipboard\n"
printf " orcli info 1234567890123\n" printf " orcli info 1234567890123\n"
echo echo
# :command.footer
printf "https://github.com/opencultureconsulting/orcli\n"
echo
fi fi
} }

1
src/bashly.yml
View File

@ -1,6 +1,7 @@
name: orcli name: orcli
help: OpenRefine command-line interface written in Bash help: OpenRefine command-line interface written in Bash
version: 0.1.0 version: 0.1.0
footer: https://github.com/opencultureconsulting/orcli
dependencies: dependencies:
- curl - curl