Repository: lens
Updated Branches:
  refs/heads/master 2ebbf455f -> e4c70644a


LENS-1194: Update README file of python client


Project: http://git-wip-us.apache.org/repos/asf/lens/repo
Commit: http://git-wip-us.apache.org/repos/asf/lens/commit/e4c70644
Tree: http://git-wip-us.apache.org/repos/asf/lens/tree/e4c70644
Diff: http://git-wip-us.apache.org/repos/asf/lens/diff/e4c70644

Branch: refs/heads/master
Commit: e4c70644aeadeefcd41eea487dd60316199fa965
Parents: 2ebbf45
Author: Rajat Khandelwal <pro...@apache.org>
Authored: Tue Jun 21 08:10:21 2016 +0800
Committer: raju <r...@apache.org>
Committed: Tue Jun 21 08:10:21 2016 +0800

----------------------------------------------------------------------
 contrib/clients/python/MANIFEST.in | 17 +++++++++++++++++
 contrib/clients/python/README      | 20 --------------------
 contrib/clients/python/README.md   | 20 ++++++++++++++++++++
 contrib/clients/python/setup.py    |  2 +-
 pom.xml                            |  2 +-
 5 files changed, 39 insertions(+), 22 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lens/blob/e4c70644/contrib/clients/python/MANIFEST.in
----------------------------------------------------------------------
diff --git a/contrib/clients/python/MANIFEST.in 
b/contrib/clients/python/MANIFEST.in
new file mode 100644
index 0000000..259f75b
--- /dev/null
+++ b/contrib/clients/python/MANIFEST.in
@@ -0,0 +1,17 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+include README.*

http://git-wip-us.apache.org/repos/asf/lens/blob/e4c70644/contrib/clients/python/README
----------------------------------------------------------------------
diff --git a/contrib/clients/python/README b/contrib/clients/python/README
deleted file mode 100644
index 732d3c9..0000000
--- a/contrib/clients/python/README
+++ /dev/null
@@ -1,20 +0,0 @@
-# lens-python-client
-Lens Python Client
-
-## Installation
-You can install like this:
-
-    pip install ...
-
-
-## Usage
-    if __name__ == '__main__':
-        with LensClient("http://lens.server.url/";, "user.name", database="db") 
as client:
-            handle = client.queries.submit("cube select ...", query_name="My 
first query")
-            # Optionally wait for completion.
-            while not client.queries[handle].finished:
-                time.sleep(20) # sleep 20 seconds
-            print client.queries[handle].result_set_path
-            # listing queries:
-            for handle in client.queries(state='RUNNING'):
-                print client.queries[handle]

http://git-wip-us.apache.org/repos/asf/lens/blob/e4c70644/contrib/clients/python/README.md
----------------------------------------------------------------------
diff --git a/contrib/clients/python/README.md b/contrib/clients/python/README.md
new file mode 100644
index 0000000..00525ff
--- /dev/null
+++ b/contrib/clients/python/README.md
@@ -0,0 +1,20 @@
+# lens-python-client
+Lens Python Client
+
+## Installation
+You can install like this:
+
+    pip install -e 
'git+https://github.com/apache/lens.git#egg=lenspythonclient&subdirectory=contrib/clients/python'
 # install a python package from a repo subdirectory
+
+
+## Usage
+    from lens.client import LensClient
+    with LensClient("http://lens.server.url/";, "user.name", database="db") as 
client:
+        handle = client.queries.submit("cube select ...", query_name="My first 
query")
+        # Optionally wait for completion.
+        while not client.queries[handle].finished:
+            time.sleep(20) # sleep 20 seconds
+        print client.queries[handle].result_set_path
+        # listing queries:
+        for handle in client.queries(state='RUNNING'):
+            print client.queries[handle]

http://git-wip-us.apache.org/repos/asf/lens/blob/e4c70644/contrib/clients/python/setup.py
----------------------------------------------------------------------
diff --git a/contrib/clients/python/setup.py b/contrib/clients/python/setup.py
index 6147c90..2d58c74 100644
--- a/contrib/clients/python/setup.py
+++ b/contrib/clients/python/setup.py
@@ -35,7 +35,7 @@ def read(*filenames, **kwargs):
             buf.append(f.read())
     return sep.join(buf)
 
-long_description = read('README')
+long_description = read('README.md')
 
 class Tox(TestCommand):
     def finalize_options(self):

http://git-wip-us.apache.org/repos/asf/lens/blob/e4c70644/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index f1b2289..176fb0e 100644
--- a/pom.xml
+++ b/pom.xml
@@ -620,7 +620,7 @@
           <useIdeaDefaultExcludes>true</useIdeaDefaultExcludes>
           <useEclipseDefaultExcludes>true</useEclipseDefaultExcludes>
           <excludes>
-            <exclude>README.*</exclude>
+            <exclude>**/README.*</exclude>
             <exclude>DEPENDENCIES</exclude>
             <exclude>**/LICENSE*</exclude>
             <!-- Local git repo -->

Reply via email to