You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by rd...@apache.org on 2019/10/23 03:25:55 UTC

[tinkerpop] 01/03: Renamed python README with .rst for easy preview via github. Also added twine check before deploy. - CTR

This is an automated email from the ASF dual-hosted git repository.

rdale pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/tinkerpop.git

commit aee3b9ec0fc15d9a3f1d73fc8cff7ac484c5ab91
Author: Robert Dale <ro...@gmail.com>
AuthorDate: Tue Oct 22 23:23:55 2019 -0400

    Renamed python README with .rst for easy preview via github. Also added twine check before deploy. - CTR
---
 gremlin-python/pom.xml                                | 5 +++++
 gremlin-python/src/main/jython/{README => README.rst} | 4 ++--
 gremlin-python/src/main/jython/setup.py               | 3 ++-
 3 files changed, 9 insertions(+), 3 deletions(-)

diff --git a/gremlin-python/pom.xml b/gremlin-python/pom.xml
index 4616870..b8bf97e 100644
--- a/gremlin-python/pom.xml
+++ b/gremlin-python/pom.xml
@@ -596,6 +596,11 @@ limitations under the License.
                                               failonerror="true">
                                             <arg line="install twine==1.12.1"/>
                                         </exec>
+					<!-- check the dist for errors before deploying -->
+                                        <exec dir="${project.build.directory}/python-packaged" executable="env/bin/twine"
+                                              failonerror="true">
+                                            <arg line="check dist/*"/>
+                                        </exec>
                                         <!-- to use the pypi test environment add: -r pypitest -->
                                         <exec dir="${project.build.directory}/python-packaged" executable="env/bin/twine"
                                               failonerror="true">
diff --git a/gremlin-python/src/main/jython/README b/gremlin-python/src/main/jython/README.rst
similarity index 95%
rename from gremlin-python/src/main/jython/README
rename to gremlin-python/src/main/jython/README.rst
index f062fcc..243579b 100644
--- a/gremlin-python/src/main/jython/README
+++ b/gremlin-python/src/main/jython/README.rst
@@ -28,8 +28,8 @@ traversals on (or queries of) their application's property graph.
 
 Gremlin-Python implements Gremlin within the Python language and can be used on any Python virtual machine including
 the popular CPython machine. Python’s syntax has the same constructs as Java including "dot notation" for function
-chaining ``(a.b.c)``, round bracket function arguments ``(a(b,c))```, and support for global namespaces
-``(a(b()) vs a(__.b()))```. As such, anyone familiar with Gremlin-Java will immediately be able to work with
+chaining ``(a.b.c)``, round bracket function arguments ``(a(b,c))``, and support for global namespaces
+``(a(b()) vs a(__.b()))``. As such, anyone familiar with Gremlin-Java will immediately be able to work with
 Gremlin-Python. Moreover, there are a few added constructs to Gremlin-Python that make traversals a bit more succinct.
 
 Gremlin-Python is designed to connect to a "server" that is hosting a TinkerPop-enabled graph system. That "server"
diff --git a/gremlin-python/src/main/jython/setup.py b/gremlin-python/src/main/jython/setup.py
index be88e0b..f99ef62 100644
--- a/gremlin-python/src/main/jython/setup.py
+++ b/gremlin-python/src/main/jython/setup.py
@@ -63,7 +63,8 @@ setup(
     license='Apache 2',
     url='http://tinkerpop.apache.org',
     description='Gremlin-Python for Apache TinkerPop',
-    long_description=codecs.open("README", "r", "UTF-8").read(),
+    long_description=codecs.open("README.rst", "r", "UTF-8").read(),
+    long_description_content_type='text/x-rst',
     test_suite="tests",
     data_files=[("", ["LICENSE", "NOTICE"])],
     setup_requires=[