[GitHub] [submarine] jiwq commented on a change in pull request #334: SUBMARINE-550. [doc] Upload pysubmarine to pypi

[GitBox <gi...@apache.org>]

jiwq commented on a change in pull request #334:
URL: https://github.com/apache/submarine/pull/334#discussion_r447671579



##########
File path: submarine-sdk/pysubmarine/README.md
##########
@@ -21,39 +21,26 @@ tracking experiment metrics, parameters.
 
 
 ## Package setup
-- Clone repository
+- Install latest version of pysubmarine
 ```bash
 git clone https://github.com/apache/submarine.git
 cd submarine/submarine-sdk/pysubmarine
-```
-- Install pip package
-```bash
 pip install .
 ```
-- Run tests
-```bash
-pytest --cov=submarine -vs
-```
-- Auto format code
-```bash
-./submarine-sdk/pysubmarine/github-actions/auto-format.sh
-```
-- Run checkstyle
-```bash
-./submarine-sdk/pysubmarine/github-actions/lint.sh
-```
-## How to generate REST SDK from swagger
+- Install package from pypi
 ```bash
-./dev-support/pysubmarine/gen-sdk.sh
+pip install submarine-sdk

Review comment:
       ```suggestion
   pip install apache-submarine
   ```

##########
File path: submarine-sdk/pysubmarine/setup.py
##########
@@ -15,11 +15,15 @@
 
 from setuptools import setup, find_packages
 
+with open('README.md') as f:
+    long_description = f.read()
 
 setup(
-    name='pysubmarine',
+    name='submarine-sdk',

Review comment:
       `PySubmarine` or `apache-submarine` ? I think it's not the `submarine-sdk`.

##########
File path: submarine-sdk/pysubmarine/setup.py
##########
@@ -43,4 +47,7 @@
         'Programming Language :: Python :: 3.6',
         'Programming Language :: Python :: 3.7',
     ],
+    license='Apache License, Version 2.0',
+    maintainer='Apache Submarine Developers',

Review comment:
       ```suggestion
       maintainer='Apache Submarine Community',
   ```




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org