Merge pull request #5 from dxFeed/EN-1228-ci-cd

[EN-1228] ci cd

Author: Aleksandr Salynskii

.github/workflow/pythonpackage.yml

@@ -0,0 +1,80 @@
+# This workflow will check package installation and runs tests
+# On Ubuntu, Windows and MacOS
+# Triggered by push to master
+
+name: Test package
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  installation:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: [3.6, 3.7, 3.8]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        submodules: true
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install poetry
+      run: |
+        pip install poetry
+      shell: bash
+    - name: Set poetry env
+      run: |
+        poetry config virtualenvs.create false
+        poetry install --no-root --no-dev
+        pip install taskipy cython
+        task build -f sdist
+        pip uninstall --yes taskipy cython
+      shell: bash
+    - name: Install package artifact
+      run: |
+        pip install dist/dxfeed*
+        pip uninstall dxfeed
+      shell: bash
+  build:
+    needs: installation
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: [3.6, 3.7, 3.8]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        submodules: true
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install poetry
+      run: |
+        pip install poetry
+      shell: bash
+    - name: Set poetry env
+      run: |
+        poetry config virtualenvs.create false
+        poetry install --no-root
+      shell: bash
+    - name: Run tests
+      run: |
+        task test
+      shell: bash
+    - name: Generate doc
+      run: |
+        task html_docs
+      shell: bash
+      if: matrix.os == 'ubuntu-latest' && matrix.python-version == 3.7

README.md

@@ -1,6 +1,13 @@
 # dxfeed package
 
-This library provides Python API to dxfeed via C API. The code is written in Python and Cython.
+This package provides access to [dxFeed](https://www.dxfeed.com/) streaming data.
+The library is build as a thin wrapper over [dxFeed C-API library](https://github.com/dxFeed/dxfeed-c-api).
+We use [Cython](https://cython.org/) in this project as it combines flexibility, reliability and
+usability in writing C extensions.
+
+This package already contains basic C-API functions related to creating connections, subscriptions etc.
+Moreover default listeners (functions responsible for event processing) are ready to use. The user is also able to
+write his own custom listener in Cython
 
 ## Installation
 
@@ -16,6 +23,13 @@ Install package via PyPI
 pip3 install dxfeed
 ``` 
 
+---
+**NOTE**
+
+MacOS is not supported yet
+
+---
+
 ## Basic usage
 
 All the functions in C API have similar ones in Python with the same name. Not all arguments are