Added README.md

Author: daviddenis-stx

.github/workflows/build.yml

@@ -1,34 +1,34 @@
-name: Upload Python Package
-
-on: 
-  push:
-    tags: v*
-
-jobs:
-  deploy:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python
-      uses: actions/setup-python@v2
-      with:
-        python-version: '3.x'
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install setuptools wheel twine grpcio grpcio-tools protobuf
-    - name: Set VERSION environment variable
-      run: |
-        echo GitHub_ref: $GITHUB_REF
-        arrTag=(${GITHUB_REF//\// })
-        VERSION="${arrTag[2]}"
-        echo Version: $VERSION
-        VERSION="${VERSION//v}"
-        echo Clean Version: $VERSION
-        echo "VERSION=${VERSION}" >> $GITHUB_ENV
-    - name: Build and publish
-      env:
-        TWINE_USERNAME: "__token__"
-        TWINE_PASSWORD: ${{ secrets.PYPI_ORG_TOKEN }}
-      run: |
+name: Upload Python Package
+
+on: 
+  push:
+    tags: v*
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine grpcio grpcio-tools protobuf
+    - name: Set VERSION environment variable
+      run: |
+        echo GitHub_ref: $GITHUB_REF
+        arrTag=(${GITHUB_REF//\// })
+        VERSION="${arrTag[2]}"
+        echo Version: $VERSION
+        VERSION="${VERSION//v}"
+        echo Clean Version: $VERSION
+        echo "VERSION=${VERSION}" >> $GITHUB_ENV
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: "__token__"
+        TWINE_PASSWORD: ${{ secrets.PYPI_ORG_TOKEN }}
+      run: |
         python ./build.py

.gitignore

@@ -1,5 +1,5 @@
-/bin
-/lib
-/pyvenv.cfg
-/python/dist
-/python/systemathics.apis.egg-info
+/bin
+/lib
+/pyvenv.cfg
+/python/dist
+/python/systemathics.apis.egg-info

README.md

@@ -0,0 +1,23 @@
+# About Ganymede
+
+Built as cloud native, Ganymede is a fully managed platform, continuously updated with high-quality, curated,
+and cross validated data. Ganymede is purpose built for the financial data markets ever increasing data volumes,
+allowing clients to query against large data sets, including tick-by-tick, sampled, daily, corporate actions,
+ESG and reference data. Packed with a broad range of analytics, the solution is optimized for fast response times,
+supports full order book natively and allows fine grained/customizable trade and quote conditions mapping and filtering.
+
+For further information, please visit [Ganymede home page](https://ganymede.cloud) 
+
+# About this project
+
+This project provides up-to-date gRPC clients to access [Ganymede API](https://ganymede.cloud/api-documentation.html)
+
+Latest Python package
+
+[![PyPI version](https://badge.fury.io/py/systemathics.apis.svg)](https://badge.fury.io/py/systemathics.apis) 
+
+# About us
+
+[Systemathics](https://systemathics.com) is a French fintech founded in 2008 developing its innovative products with the highest quality standards 100% in France.
+Our main mission is to provide global investors with a complete end-to-end solution to systematize alpha generation in a robust way.
+From data pre and post trade analysis, back-testing, risk assessment and signal generation to day-to-day execution in production and everything in between.

buf.yaml

@@ -1,12 +1,12 @@
-version: v1beta1
-build:
-  roots:
-    - src
-lint:
-  use:
-    - DEFAULT
-  ignore:
-    - google
-breaking:
-  use:
+version: v1beta1
+build:
+  roots:
+    - src
+lint:
+  use:
+    - DEFAULT
+  ignore:
+    - google
+breaking:
+  use:
     - FILE

python/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2021 Systemathics
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2021 Systemathics
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

python/README.rst

@@ -0,0 +1,34 @@
+About Ganymede
+==============
+
+Built as cloud native, Ganymede is a fully managed platform,
+continuously updated with high-quality, curated, and cross validated
+data. Ganymede is purpose built for the financial data markets ever
+increasing data volumes, allowing clients to query against large data
+sets, including tick-by-tick, sampled, daily, corporate actions, ESG and
+reference data. Packed with a broad range of analytics, the solution is
+optimized for fast response times, supports full order book natively and
+allows fine grained/customizable trade and quote conditions mapping and
+filtering.
+
+For further information, please visit `Ganymede home
+page <https://ganymede.cloud>`__
+
+About this package
+===================
+
+This package provides up-to-date gRPC clients to access `Ganymede
+API <https://ganymede.cloud/api-documentation.html>`__
+
+Python version
+
+About us
+========
+
+`Systemathics <https://systemathics.com>`__ is a French fintech founded
+in 2008 developing its innovative products with the highest quality
+standards 100% in France. Our main mission is to provide global
+investors with a complete end-to-end solution to systematize alpha
+generation in a robust way. From data pre and post trade analysis,
+back-testing, risk assessment and signal generation to day-to-day
+execution in production and everything in between.

python/setup.cfg

@@ -1,2 +1,2 @@
-[bdist_wheel]
+[bdist_wheel]
 universal=1

python/setup.py

@@ -3,21 +3,30 @@
 
 from setuptools import setup, find_packages
 
+with open(os.path.join(os.path.abspath(os.path.dirname(__file__)), 'README.rst'), encoding='utf-8') as f:
+    lines = f.readlines()
+    description_content = "".join(lines)
+
 setup(
     name="systemathics.apis",
     version="0.0.0",
     author="Systemathics",
     author_email="contact@systemathics.com",
-    description="Python grpc stub for Systemathics APIs.",
-    url="https://github.com/pypa/sampleproject",
+    description="Python grpc stub for Systemathics API.",
+    url="https://github.com/systemathics/sdk-python",
     packages=find_packages(),
     namespace_packages=['systemathics'],
     classifiers=[
         "Programming Language :: Python :: 3",
         "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",
+        "Intended Audience :: Developers",
+        "Intended Audience :: Information Technology",
+        "Intended Audience :: Science/Research"
     ],
     license='MIT',
     python_requires='>=3.6',
     install_requires=['googleapis-common-protos', 'protobuf', 'grpcio'],
-)
+    long_description= description_content,
+    long_description_content_type="text/x-rst; charset=UTF-8"
+)

src/systemathics/apis/helpers/channel_helpers.py

@@ -1,10 +1,10 @@
-"""Systemathics Ganymede APIs Token Helpers
+"""Systemathics Ganymede API Token Helpers
 
-This module helps to create channels to access Systemathics Ganymede authenticated APIs.
+This module helps to create channels to access Systemathics Ganymede authenticated API.
 
 functions:
-    * get_grpc_channel - Get a channel suitable to call Ganymede gRPC APIs.
-    * get_aio_grpc_channel - Get an aio channel suitable to call Ganymede gRPC APIs.
+    * get_grpc_channel - Get a channel suitable to call Ganymede gRPC API.
+    * get_aio_grpc_channel - Get an aio channel suitable to call Ganymede gRPC API.
 """
 
 import os
@@ -15,15 +15,15 @@
 
 def get_grpc_channel() -> grpc.Channel:
     """
-    Get a channel suitable to call Ganymede gRPC APIs.
+    Get a channel suitable to call Ganymede gRPC API.
     This uses the GRPC_APIS environment variable in the form http[s]://fdqn[:port] (if no scheme is give, we'll assume https).
     If none is detected, use DEFAULT_ENDPOINT.
     Note:
         For secure channels, we'll try to guess the path of CA certificates chain automatically.
         For windows you need to 'pip install wheel python-certifi-win32' for that to work (it exports Windows CA Store to a PEM file).
         In the event CA certificates cannot be found, or if you want to use a custom file, set the SSL_CERT_FILE environment variable.
     Returns:
-        An aio channel suitable to call Ganymede gRPC APIs.
+        An aio channel suitable to call Ganymede gRPC API.
     """
     endpoint = os.getenv('GRPC_APIS','')
     endpoint = endpoint if endpoint else DEFAULT_ENDPOINT # if no endpoint was provided, use the default one
@@ -35,15 +35,15 @@ def get_grpc_channel() -> grpc.Channel:
 
 def get_aio_grpc_channel() -> grpc.aio.Channel:
     """
-    Get an aio channel suitable to call Ganymede gRPC APIs.
+    Get an aio channel suitable to call Ganymede gRPC API.
     This uses the GRPC_APIS environment variable in the form http[s]://fdqn[:port].
     If none is detected, use DEFAULT_ENDPOINT.
     Note:
         For secure channels, we'll try to guess the path of CA certificates chain automatically.
         For windows you need to 'pip install wheel python-certifi-win32' for that to work (it exports Windows CA Store to a PEM file).
         In the event CA certificates cannot be found, or if you want to use a custom file, set the SSL_CERT_FILE environment variable.
     Returns:
-        An aio channel suitable to call Ganymede gRPC APIs.
+        An aio channel suitable to call Ganymede gRPC API.
     """
     endpoint = os.getenv('GRPC_APIS','')
     endpoint = endpoint if endpoint else DEFAULT_ENDPOINT # if no endpoint was provided, use the default one

src/systemathics/apis/helpers/token_helpers.py

@@ -1,9 +1,9 @@
-"""Systemathics Ganymede  APIs Token Helpers
+"""Systemathics Ganymede  API Token Helpers
 
-This module helps to create tokens to access Systemathics Ganymede authenticated APIs.
+This module helps to create tokens to access Systemathics Ganymede authenticated API.
 
 functions:
-    * get_token - Get a JWT Authorization token suitable to call Ganymede gRPC APIs.
+    * get_token - Get a JWT Authorization token suitable to call Ganymede gRPC API.
 """
 
 import os
@@ -16,21 +16,21 @@
 
 def get_token_as_metadata() -> []:
     """
-    Get a JWT Authorization token suitable to call Ganymede gRPC APIs.
+    Get a JWT Authorization token suitable to call Ganymede gRPC API.
     We either use 'AUTH0_TOKEN' environment variable (if present) to create a bearer token from it.
     Or 'CLIENT_ID' and 'CLIENT_SECRET' environment variables (optionally 'AUDIENCE' can override DEFAULT_AUDIENCE, and 'TENANT' can override DEFAULT_TENANT).  
     Returns:
-        A JWT Authorization token suitable to call Ganymede gRPC APIs in a form directly assignable to metadata= in stub call, that is [('authorization', get_token())].
+        A JWT Authorization token suitable to call Ganymede gRPC API in a form directly assignable to metadata= in stub call, that is [('authorization', get_token())].
     """
     return [('authorization', get_token())]
 
 def get_token() -> str:    
     """
-    Get a JWT Authorization token suitable to call Ganymede gRPC APIs.
+    Get a JWT Authorization token suitable to call Ganymede gRPC API.
     We either use 'AUTH0_TOKEN' environment variable (if present) to create a bearer token from it.
     Or 'CLIENT_ID' and 'CLIENT_SECRET' environment variables (optionally 'AUDIENCE' can override DEFAULT_AUDIENCE, and 'TENANT' can override DEFAULT_TENANT).  
     Returns:
-        A JWT Authorization token suitable to call Ganymede gRPC APIs.
+        A JWT Authorization token suitable to call Ganymede gRPC API.
     """
     auth0_token = os.getenv("AUTH0_TOKEN","")
     client_id = os.getenv("CLIENT_ID","")