Add README.rst and Makefile
This commit is contained in:
parent
6d59e2e2cf
commit
4d97828324
|
@ -0,0 +1,11 @@
|
||||||
|
# XXX have a Makefile written by someone that knows Makefiles...
|
||||||
|
|
||||||
|
SMALL_TEST_FILES = google/test/test_refine_small.py google/test/test_facet.py google/test/test_history.py
|
||||||
|
LARGE_TEST_FILES = google/test/test_refine.py google/test/test_tutorial.py
|
||||||
|
TEST_FILES = $(SMALL_TEST_FILES) $(LARGE_TEST_FILES)
|
||||||
|
|
||||||
|
test: $(TEST_FILES)
|
||||||
|
PYTHONPATH=. sh -c 'for t in $(TEST_FILES); do python $$t; done'
|
||||||
|
|
||||||
|
smalltest: $(SMALL_TEST_FILES)
|
||||||
|
PYTHONPATH=. sh -c 'for t in $(SMALL_TEST_FILES); do python $$t; done'
|
|
@ -0,0 +1,74 @@
|
||||||
|
===================================
|
||||||
|
Google Refine Python Client Library
|
||||||
|
===================================
|
||||||
|
|
||||||
|
The Google Refine Python Client Library provides an interface to
|
||||||
|
communicating with a Google Refine server.
|
||||||
|
|
||||||
|
Currently, the following API is supported:
|
||||||
|
|
||||||
|
- project creation/import, deletion, export
|
||||||
|
- facet computation
|
||||||
|
|
||||||
|
- text
|
||||||
|
- text filter
|
||||||
|
- numeric
|
||||||
|
- blank
|
||||||
|
- starred & flagged
|
||||||
|
- ... extensible class
|
||||||
|
|
||||||
|
- 'engine': managing multiple facets and their computation results
|
||||||
|
- sorting & reordering
|
||||||
|
- clustering
|
||||||
|
- transforms
|
||||||
|
- transposes
|
||||||
|
- single and mass edits
|
||||||
|
- annotation (star/flag)
|
||||||
|
- column
|
||||||
|
|
||||||
|
- move
|
||||||
|
- add
|
||||||
|
- split
|
||||||
|
- rename
|
||||||
|
- reorder
|
||||||
|
- remove
|
||||||
|
|
||||||
|
Configuration
|
||||||
|
=============
|
||||||
|
|
||||||
|
By default the Google Refine server URL is http://127.0.0.1:3333
|
||||||
|
The environment variables `GOOGLE_REFINE_HOST` and `GOOGLE_REFINE_PORT`
|
||||||
|
enable overriding the host & port.
|
||||||
|
|
||||||
|
In order to run all tests, a live Refine server is needed.
|
||||||
|
|
||||||
|
Installation
|
||||||
|
============
|
||||||
|
|
||||||
|
#. Run tests:
|
||||||
|
|
||||||
|
make test
|
||||||
|
|
||||||
|
#. TODO
|
||||||
|
|
||||||
|
TODO
|
||||||
|
====
|
||||||
|
|
||||||
|
The API so far has been filled out from building a test suite to carry out the
|
||||||
|
actions in David Huynh's Refine tutorial
|
||||||
|
http://davidhuynh.net/spaces/nicar2011/tutorial.pdf which while certainly
|
||||||
|
showing off a wide range of Refine features doesn't cover the entire suite.
|
||||||
|
Notable exceptions currently include:
|
||||||
|
|
||||||
|
- reconciliation
|
||||||
|
- undo/redo
|
||||||
|
- Freebase
|
||||||
|
- join columns
|
||||||
|
- columns from URL
|
||||||
|
|
||||||
|
Credits
|
||||||
|
=======
|
||||||
|
|
||||||
|
Paul Makepeace, author
|
||||||
|
|
||||||
|
David Huynh, initial cut: http://groups.google.com/group/google-refine/msg/ee29cf8d660e66a9
|
Loading…
Reference in New Issue