From d82c7b28fb86da1847ebe36e8336bf534ad3aee5 Mon Sep 17 00:00:00 2001 From: Felix Lohmeier Date: Sat, 3 Aug 2019 13:23:32 +0200 Subject: [PATCH] Revert "refactor to allow module execution" This reverts commit a0123e951171cb22eddac6c65a23c2d8a28a88dc. --- Makefile | 32 ++++++++++++++++++++++++++++ README.md | 26 ++++++++++++++-------- docker/Dockerfile | 16 +++++++------- {refine => google}/__init__.py | 0 google/refine/__init__.py | 0 {refine => google/refine}/facet.py | 0 {refine => google/refine}/history.py | 0 {refine => google/refine}/refine.py | 4 ++-- refine/__main__.py => refine.py | 4 ++-- setup.py | 6 +----- tests/refinetest.py | 2 +- tests/test_facet.py | 2 +- tests/test_history.py | 2 +- tests/test_refine.py | 2 +- tests/test_refine_small.py | 2 +- tests/test_tutorial.py | 2 +- 16 files changed, 68 insertions(+), 32 deletions(-) create mode 100644 Makefile rename {refine => google}/__init__.py (100%) create mode 100644 google/refine/__init__.py rename {refine => google/refine}/facet.py (100%) rename {refine => google/refine}/history.py (100%) rename {refine => google/refine}/refine.py (99%) rename refine/__main__.py => refine.py (99%) diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..5ee5c1a --- /dev/null +++ b/Makefile @@ -0,0 +1,32 @@ +# XXX have a Makefile written by someone that knows Makefiles... + +all: test build install + +readme: + # requires docutils, e.g. pip install docutils + rst2html.py README.rst > README.html + w3m -dump README.html | unix2dos > README.txt + +test: + python setup.py test + +# tests that don't require a Refine server running +smalltest: + python setup.py test --test-suite tests.test_refine_small + python setup.py test --test-suite tests.test_facet + python setup.py test --test-suite tests.test_history + +build: + python setup.py build + +install: + sudo python setup.py install + +clean: + find . -name '*.pyc' | xargs rm -f + # XXX is there some way of having setup.py clean up its junk? + rm -rf README.{html,txt} build dist refine_client.egg-info distribute-* + +upload: clean + python setup.py sdist upload + diff --git a/README.md b/README.md index 1d00e28..6404fb4 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # OpenRefine Python Client with extended command line interface -The [OpenRefine Python Client Library from PaulMakepeace](https://github.com/PaulMakepeace/refine-client-py) provides an interface to communicating with an [OpenRefine](http://openrefine.org) server. -This fork extends the command line interface (CLI) and supports communication between docker containers. +The [OpenRefine Python Client Library from PaulMakepeace](https://github.com/PaulMakepeace/refine-client-py) provides an interface to communicating with an [OpenRefine](http://openrefine.org) server. This fork extends the command line interface (CLI) and supports communication between docker containers. ## Download @@ -32,7 +31,7 @@ Command line interface: - delete project: `--delete [PROJECTID/PROJECTNAME]` - check `--help` for further options... -If you are familiar with python you may try all functions interactively (`python -i refine/refine.py`) or use this library in your own python scripts. Some Examples: +If you are familiar with python you may try all functions interactively (`python -i refine.py`) or use this library in your own python scripts. Some Examples: * show version of OpenRefine server: `refine.RefineServer().get_version()` * show total rows of project 2151545447855: `refine.RefineProject(refine.RefineServer(),'2151545447855').do_json('get-rows')['total']` @@ -46,16 +45,25 @@ The environment variables `OPENREFINE_HOST` and `OPENREFINE_PORT` enable overrid ## Installation -```pip install openrefine-client``` +Install dependencies, which currently is `urllib2_file`: -(requires Python 2.x, depends on urllib2_file>=0.2.1) +``` +sudo pip install -r requirements.txt +``` -## Tests +Ensure you have a Refine server running somewhere and, if necessary, set the environment vars as above. -Ensure you have an OpenRefine server running somewhere and, if necessary, set the environment vars as above. +Run tests, build, and install: -* all tests: ```python setup.py test``` -* a subset: ```python setup.py test --test-suite tests.test_facet``` +``` +python setup.py test # to do a subset, e.g., --test-suite tests.test_facet + +python setup.py build + +python setup.py install +``` + +There is a Makefile that will do this too, and more. ## Credits diff --git a/docker/Dockerfile b/docker/Dockerfile index 7dd3d44..47d98b2 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -3,26 +3,26 @@ LABEL maintainer="felixlohmeier@opencultureconsulting.com" # The OpenRefine Python Client Library from PaulMakepeace provides an interface to communicating with an OpenRefine server. This fork extends the command line interface (CLI) and supports communication between docker containers. # Source: https://github.com/opencultureconsulting/openrefine-client -# Install python, pip, unzip, curl and grep +# Install python and pip +# ... and curl for https://github.com/opencultureconsulting/openrefine-batch RUN apk add --no-cache \ python \ py-pip \ - unzip \ - curl \ - grep + curl # Install dependency urllib2_file RUN pip install urllib2_file==0.2.1 -# Copy python scripts +# Download and build openrefine-client-master WORKDIR /app -COPY refine/* ./ +COPY google google +COPY refine.py . # Change docker WORKDIR (shall be mounted by user) WORKDIR /data -# Execute main python script -ENTRYPOINT ["/app/__main__.py"] +# Execute refine.py +ENTRYPOINT ["/app/refine.py"] # Default command: print help CMD ["-h"] diff --git a/refine/__init__.py b/google/__init__.py similarity index 100% rename from refine/__init__.py rename to google/__init__.py diff --git a/google/refine/__init__.py b/google/refine/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/refine/facet.py b/google/refine/facet.py similarity index 100% rename from refine/facet.py rename to google/refine/facet.py diff --git a/refine/history.py b/google/refine/history.py similarity index 100% rename from refine/history.py rename to google/refine/history.py diff --git a/refine/refine.py b/google/refine/refine.py similarity index 99% rename from refine/refine.py rename to google/refine/refine.py index d9102ee..9ac09df 100644 --- a/refine/refine.py +++ b/google/refine/refine.py @@ -30,8 +30,8 @@ import urllib2_file import urllib2 import urlparse -import facet -import history +from google.refine import facet +from google.refine import history REFINE_HOST = os.environ.get('OPENREFINE_HOST', os.environ.get('GOOGLE_REFINE_HOST', '127.0.0.1')) REFINE_PORT = os.environ.get('OPENREFINE_PORT', os.environ.get('GOOGLE_REFINE_PORT', '3333')) diff --git a/refine/__main__.py b/refine.py similarity index 99% rename from refine/__main__.py rename to refine.py index fa7ecd7..bd4b75d 100755 --- a/refine/__main__.py +++ b/refine.py @@ -25,7 +25,7 @@ import sys import time import json -import refine +from google.refine import refine reload(sys) sys.setdefaultencoding('utf-8') @@ -37,7 +37,7 @@ class myParser(optparse.OptionParser): PARSER = \ myParser(description='Script to provide a command line interface to an OpenRefine server.', - usage='usage: openrefine-client [--help | OPTIONS]', + usage='usage: %prog [--help | OPTIONS]', epilog=""" Examples: --list # show list of projects (id: name) diff --git a/setup.py b/setup.py index 8063539..99381ca 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.5', + version='0.3.4', description=('The OpenRefine Python Client Library provides an ' 'interface to communicating with an OpenRefine server. ' 'This fork extends the command line interface (CLI).'), @@ -34,11 +34,7 @@ setup(name='openrefine-client', author_email='felix.lohmeier@opencultureconsulting.com', url='https://github.com/opencultureconsulting/openrefine-client', packages=find_packages(exclude=['tests']), - python_requires='>2.6, !=3.*', install_requires=['urllib2_file'], - entry_points={ - 'console_scripts': [ 'openrefine-client = refine.__main__:main' ] - }, platforms=['Any'], classifiers = [ 'Development Status :: 3 - Alpha', diff --git a/tests/refinetest.py b/tests/refinetest.py index f9eecea..ea3b3de 100644 --- a/tests/refinetest.py +++ b/tests/refinetest.py @@ -15,7 +15,7 @@ and REFINE_PORT. import os import unittest -from refine import refine +from google.refine import refine PATH_TO_TEST_DATA = os.path.join(os.path.dirname(__file__), 'data') diff --git a/tests/test_facet.py b/tests/test_facet.py index ccd9d17..32746b7 100644 --- a/tests/test_facet.py +++ b/tests/test_facet.py @@ -8,7 +8,7 @@ test_facet.py import json import unittest -from refine.facet import * +from google.refine.facet import * class CamelTest(unittest.TestCase): diff --git a/tests/test_history.py b/tests/test_history.py index 51d0581..044a5f2 100644 --- a/tests/test_history.py +++ b/tests/test_history.py @@ -7,7 +7,7 @@ test_history.py import unittest -from refine.history import * +from google.refine.history import * class HistoryTest(unittest.TestCase): diff --git a/tests/test_refine.py b/tests/test_refine.py index 32b1f26..7c65dbb 100644 --- a/tests/test_refine.py +++ b/tests/test_refine.py @@ -12,7 +12,7 @@ OPENREFINE_HOST and OPENREFINE_PORT. import csv import unittest -from refine import refine +from google.refine import refine from tests import refinetest diff --git a/tests/test_refine_small.py b/tests/test_refine_small.py index 2fea523..c525ba5 100644 --- a/tests/test_refine_small.py +++ b/tests/test_refine_small.py @@ -7,7 +7,7 @@ test_refine_small.py import unittest -from refine import refine +from google.refine import refine class RefineRowsTest(unittest.TestCase): diff --git a/tests/test_tutorial.py b/tests/test_tutorial.py index ca75ea4..f4e7545 100644 --- a/tests/test_tutorial.py +++ b/tests/test_tutorial.py @@ -16,7 +16,7 @@ OPENREFINE_HOST and OPENREFINE_PORT. import unittest -from refine import facet +from google.refine import facet from tests import refinetest