From 909deadf463f9f6ee5a65ee35462b885c1f97f22 Mon Sep 17 00:00:00 2001 From: Felix Lohmeier Date: Mon, 4 Apr 2022 23:00:37 +0200 Subject: [PATCH] set goals for 0.2.0 milestone --- README.md | 16 +++++++++------- orcli | 3 +++ src/bashly.yml | 1 + 3 files changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 6cdfa62..97fbb31 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,12 @@ Bash script to control OpenRefine via [its HTTP API](https://docs.openrefine.org ## Features * works with latest OpenRefine version (currently 3.5) -* provides nested sub-commands with help screens and usage examples -* supports batch processing (import, transform, export) with dedicated OpenRefine instances -* 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 -* 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 +* nested sub-commands with help screens and usage examples +* 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) +* 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~~ +* ~~[templating export](https://docs.openrefine.org/manual/exporting#templating-exporter) to additional formats like JSON or XML~~ ## 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. ```sh -[felix@tux orcli]$ ./orcli --help +$ orcli --help orcli - OpenRefine command-line interface written in Bash Usage: @@ -74,6 +74,8 @@ Examples: orcli list orcli info clipboard orcli info 1234567890123 + +https://github.com/opencultureconsulting/orcli ``` ## Development diff --git a/orcli b/orcli index 0962f40..1d3ba7a 100755 --- a/orcli +++ b/orcli @@ -69,6 +69,9 @@ orcli_usage() { printf " orcli info clipboard\n" printf " orcli info 1234567890123\n" echo + # :command.footer + printf "https://github.com/opencultureconsulting/orcli\n" + echo fi } diff --git a/src/bashly.yml b/src/bashly.yml index d443558..321a0ed 100644 --- a/src/bashly.yml +++ b/src/bashly.yml @@ -1,6 +1,7 @@ name: orcli help: OpenRefine command-line interface written in Bash version: 0.1.0 +footer: https://github.com/opencultureconsulting/orcli dependencies: - curl