From c80bef3fb1a4908f73b26ae9f64b4f4180452993 Mon Sep 17 00:00:00 2001 From: Felix Lohmeier Date: Thu, 22 Aug 2019 03:18:36 +0200 Subject: [PATCH] release v0.3.8 --- README.md | 83 ++++++++++++++++++++++++++++++------------------------- setup.py | 2 +- 2 files changed, 47 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index 1cd720c..090ea66 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,9 @@ It is also available via Docker Hub, PyPI and Binder. One-file-executables: -- Windows: [openrefine-client_0-3-7_windows.exe](https://github.com/opencultureconsulting/openrefine-client/releases/download/v0.3.7/openrefine-client_0-3-7_windows.exe) (~5 MB) -- macOS: [openrefine-client_0-3-7_macos](https://github.com/opencultureconsulting/openrefine-client/releases/download/v0.3.7/openrefine-client_0-3-7_macos) (~5 MB) -- Linux: [openrefine-client_0-3-7_linux](https://github.com/opencultureconsulting/openrefine-client/releases/download/v0.3.7/openrefine-client_0-3-7_linux) (~5 MB) +- Windows: [openrefine-client_0-3-8_windows.exe](https://github.com/opencultureconsulting/openrefine-client/releases/download/v0.3.8/openrefine-client_0-3-8_windows.exe) (~5 MB) +- macOS: [openrefine-client_0-3-8_macos](https://github.com/opencultureconsulting/openrefine-client/releases/download/v0.3.8/openrefine-client_0-3-8_macos) (~5 MB) +- Linux: [openrefine-client_0-3-8_linux](https://github.com/opencultureconsulting/openrefine-client/releases/download/v0.3.8/openrefine-client_0-3-8_linux) (~5 MB) For [Docker](#docker) containers, native [Python](#python) installation and free [Binder](#binder) on-demand server see the corresponding chapters below. @@ -55,13 +55,13 @@ To use the client: - macOS: ```sh - chmod +x openrefine-client_0-3-7_macos + chmod +x openrefine-client_0-3-8_macos ``` - Linux: ```sh - chmod +x openrefine-client_0-3-7_linux + chmod +x openrefine-client_0-3-8_linux ``` 3. Execute the file. @@ -69,19 +69,19 @@ To use the client: - Windows: ```sh - .\openrefine-client_0-3-7_windows.exe + .\openrefine-client_0-3-8_windows.exe ``` - macOS: ```sh - ./openrefine-client_0-3-7_macos + ./openrefine-client_0-3-8_macos ``` - Linux: ```sh - ./openrefine-client_0-3-7_linux + ./openrefine-client_0-3-8_linux ``` Using tab completion and command history is highly recommended: @@ -100,25 +100,25 @@ Download example data (`--download`) and create project from file (`--create`): - Windows: ```sh - .\openrefine-client_0-3-7_windows.exe --download "https://git.io/fj5hF" --output=duplicates.csv - .\openrefine-client_0-3-7_windows.exe --download "https://git.io/fj5ju" --output=duplicates-deletion.json - .\openrefine-client_0-3-7_windows.exe --create duplicates.csv + .\openrefine-client_0-3-8_windows.exe --download "https://git.io/fj5hF" --output=duplicates.csv + .\openrefine-client_0-3-8_windows.exe --download "https://git.io/fj5ju" --output=duplicates-deletion.json + .\openrefine-client_0-3-8_windows.exe --create duplicates.csv ``` - macOS: ```sh - ./openrefine-client_0-3-7_macos --download "https://git.io/fj5hF" --output=duplicates.csv - ./openrefine-client_0-3-7_macos --download "https://git.io/fj5ju" --output=duplicates-deletion.json - ./openrefine-client_0-3-7_macos --create duplicates.csv + ./openrefine-client_0-3-8_macos --download "https://git.io/fj5hF" --output=duplicates.csv + ./openrefine-client_0-3-8_macos --download "https://git.io/fj5ju" --output=duplicates-deletion.json + ./openrefine-client_0-3-8_macos --create duplicates.csv ``` - Linux: ```sh - ./openrefine-client_0-3-7_linux --download "https://git.io/fj5hF" --output=duplicates.csv - ./openrefine-client_0-3-7_linux --download "https://git.io/fj5ju" --output=duplicates-deletion.json - ./openrefine-client_0-3-7_linux --create duplicates.csv + ./openrefine-client_0-3-8_linux --download "https://git.io/fj5hF" --output=duplicates.csv + ./openrefine-client_0-3-8_linux --download "https://git.io/fj5ju" --output=duplicates-deletion.json + ./openrefine-client_0-3-8_linux --create duplicates.csv ``` Other commands: @@ -230,7 +230,7 @@ When using this option, the first column should contain unique identifiers. [felixlohmeier/openrefine-client](https://hub.docker.com/r/felixlohmeier/openrefine-client/) [![Docker](https://img.shields.io/microbadger/image-size/felixlohmeier/openrefine-client?label=docker)](https://hub.docker.com/r/felixlohmeier/openrefine-client/) ```sh -docker pull felixlohmeier/openrefine-client:v0.3.7 +docker pull felixlohmeier/openrefine-client:v0.3.8 ``` ### Option 1: Dockerized client @@ -238,7 +238,7 @@ docker pull felixlohmeier/openrefine-client:v0.3.7 Run client and mount current directory as workspace: ```sh -docker run --rm --network=host -v ${PWD}:/data:z felixlohmeier/openrefine-client:v0.3.7 +docker run --rm --network=host -v ${PWD}:/data:z felixlohmeier/openrefine-client:v0.3.8 ``` The docker option `--network=host` allows you to connect to a local or remote OpenRefine via the host network: @@ -246,13 +246,13 @@ The docker option `--network=host` allows you to connect to a local or remote Op - list projects on default URL (http://localhost:3333) ```sh - docker run --rm --network=host -v ${PWD}:/data:z felixlohmeier/openrefine-client:v0.3.7 --list + docker run --rm --network=host -v ${PWD}:/data:z felixlohmeier/openrefine-client:v0.3.8 --list ``` - list projects on a remote server (http://example.com) ```sh - docker run --rm --network=host -v ${PWD}:/data:z felixlohmeier/openrefine-client:v0.3.7 -H example.com -P 80 --list + docker run --rm --network=host -v ${PWD}:/data:z felixlohmeier/openrefine-client:v0.3.8 -H example.com -P 80 --list ``` Usage: same commands as explained above (see [Basic Commands](#basic-commands) and [Advanced Templating](#advanced-templating)) @@ -276,16 +276,16 @@ Run openrefine-client linked to a dockerized OpenRefine ([felixlohmeier/openrefi 3. Run client with some [basic commands](#basic-commands): 1. download example files, 2. create project from file, 3. list projects, 4. show metadata, 5. export to terminal, 6. apply transformation rules (deduplication), 7. export again to terminal, 8. export to xls file and 9. delete project ```sh - docker run --rm --network=openrefine -v ${PWD}:/data:z felixlohmeier/openrefine-client:v0.3.7 --download "https://git.io/fj5hF" --output=duplicates.csv - docker run --rm --network=openrefine -v ${PWD}:/data:z felixlohmeier/openrefine-client:v0.3.7 --download "https://git.io/fj5ju" --output=duplicates-deletion.json - docker run --rm --network=openrefine -v ${PWD}:/data:z felixlohmeier/openrefine-client:v0.3.7 -H openrefine-server --create duplicates.csv - docker run --rm --network=openrefine -v ${PWD}:/data:z felixlohmeier/openrefine-client:v0.3.7 -H openrefine-server --list - docker run --rm --network=openrefine -v ${PWD}:/data:z felixlohmeier/openrefine-client:v0.3.7 -H openrefine-server --info "duplicates" - docker run --rm --network=openrefine -v ${PWD}:/data:z felixlohmeier/openrefine-client:v0.3.7 -H openrefine-server --export "duplicates" - docker run --rm --network=openrefine -v ${PWD}:/data:z felixlohmeier/openrefine-client:v0.3.7 -H openrefine-server --apply duplicates-deletion.json "duplicates" - docker run --rm --network=openrefine -v ${PWD}:/data:z felixlohmeier/openrefine-client:v0.3.7 -H openrefine-server --export "duplicates" - docker run --rm --network=openrefine -v ${PWD}:/data:z felixlohmeier/openrefine-client:v0.3.7 -H openrefine-server --export --output=deduped.xls "duplicates" - docker run --rm --network=openrefine -v ${PWD}:/data:z felixlohmeier/openrefine-client:v0.3.7 -H openrefine-server --delete "duplicates" + docker run --rm --network=openrefine -v ${PWD}:/data:z felixlohmeier/openrefine-client:v0.3.8 --download "https://git.io/fj5hF" --output=duplicates.csv + docker run --rm --network=openrefine -v ${PWD}:/data:z felixlohmeier/openrefine-client:v0.3.8 --download "https://git.io/fj5ju" --output=duplicates-deletion.json + docker run --rm --network=openrefine -v ${PWD}:/data:z felixlohmeier/openrefine-client:v0.3.8 -H openrefine-server --create duplicates.csv + docker run --rm --network=openrefine -v ${PWD}:/data:z felixlohmeier/openrefine-client:v0.3.8 -H openrefine-server --list + docker run --rm --network=openrefine -v ${PWD}:/data:z felixlohmeier/openrefine-client:v0.3.8 -H openrefine-server --info "duplicates" + docker run --rm --network=openrefine -v ${PWD}:/data:z felixlohmeier/openrefine-client:v0.3.8 -H openrefine-server --export "duplicates" + docker run --rm --network=openrefine -v ${PWD}:/data:z felixlohmeier/openrefine-client:v0.3.8 -H openrefine-server --apply duplicates-deletion.json "duplicates" + docker run --rm --network=openrefine -v ${PWD}:/data:z felixlohmeier/openrefine-client:v0.3.8 -H openrefine-server --export "duplicates" + docker run --rm --network=openrefine -v ${PWD}:/data:z felixlohmeier/openrefine-client:v0.3.8 -H openrefine-server --export --output=deduped.xls "duplicates" + docker run --rm --network=openrefine -v ${PWD}:/data:z felixlohmeier/openrefine-client:v0.3.8 -H openrefine-server --delete "duplicates" ``` 4. Stop and delete server: @@ -656,11 +656,13 @@ Note to myself: When releasing a new version... ```sh ./tests.sh -a + jupyter notebook tests/cli_python2.ipynb ``` -2. Make final changes in GitHub +2. Make final changes in Git - - update versions and download links (guess in advance) in [README.md](https://github.com/opencultureconsulting/openrefine-client/blob/master/README.md#download) + - update versions (e.g. 0.3.7 und 0-3-7) in [README.md](https://github.com/opencultureconsulting/openrefine-client/blob/master/README.md#download) + - update version in [setup.py](https://github.com/opencultureconsulting/openrefine-client/blob/master/setup.py) - check if [Dockerfile](https://github.com/opencultureconsulting/openrefine-client/blob/master/docker/Dockerfile) needs to be changed 3. Build executables with PyInstaller @@ -681,23 +683,30 @@ Note to myself: When releasing a new version... pyinstaller --onefile refine.py --hidden-import google.refine.__main__ ``` -4. Create release in GitHub +4. Run test with Linux executable + + ```sh + ./tests.sh -a + jupyter notebook tests/cli_bash.ipynb + ``` + +5. Create release in GitHub - draft [release notes](https://github.com/opencultureconsulting/openrefine-client/releases) and attach one-file-executables -5. Build package and upload to PyPI +6. Build package and upload to PyPI ```sh python3 setup.py sdist bdist_wheel python3 -m twine upload dist/* ``` -6. Update Docker container +7. Update Docker container - add new autobuild for release version - trigger latest build -7. Bump openrefine-client version in related projects +8. Bump openrefine-client version in related projects - openrefine-batch: [openrefine-batch.sh](https://github.com/opencultureconsulting/openrefine-batch/blob/master/openrefine-batch.sh#L7) and [openrefine-batch-docker.sh](https://github.com/opencultureconsulting/openrefine-batch/blob/master/openrefine-batch-docker.sh) diff --git a/setup.py b/setup.py index 504aaf4..dbbcc5a 100644 --- a/setup.py +++ b/setup.py @@ -25,7 +25,7 @@ def read(filename): return open(os.path.join(os.path.dirname(__file__), filename)).read() setup(name='openrefine-client', - version='0.3.7', + version='0.3.8', description=('The OpenRefine Python Client Library provides an ' 'interface to communicating with an OpenRefine server. ' 'This fork extends the command line interface (CLI).'),