Merge pull request #17 from Finterion/feature/poetry-package

Feature/poetry package

Author: MDUYN

.github/workflows/publish.yml

@@ -0,0 +1,17 @@
+name: Build and publish python package
+
+on:
+  release:
+    types: [ published ]
+
+jobs:
+  publish-service-client-package:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Publish PyPi package
+        uses: code-specialist/pypi-poetry-publish@v1
+        with:
+          ACCESS_TOKEN: ${{ secrets.REPOSITORY_ACCESS_TOKEN }}
+          PUBLISH_REGISTRY_PASSWORD: ${{ secrets.PYPI_TOKEN }}

.github/workflows/test.yml

@@ -1,42 +1,99 @@
-# This workflow will install Python dependencies, run tests and lint
-# with a single version of Python
-
-name: Tests
+name: test
 
 on:
   push:
     branches:
       - '*'         # matches every branch that doesn't contain a '/'
       - '*/*'       # matches every branch containing a single '/'
       - '**'        # matches every branch
-  pull_request:
-    branches:
-      - '*'         # matches every branch that doesn't contain a '/'
-      - '*/*'       # matches every branch containing a single '/'
-      - '**'        # matches every branch
-jobs:
-  testing:
+    pull_request:
+      branches:
+        - '*'         # matches every branch that doesn't contain a '/'
+        - '*/*'       # matches every branch containing a single '/'
+        - '**'        # matches every branch
 
+jobs:
+  linting:
     runs-on: ubuntu-latest
-
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python 3.9
-      uses: actions/setup-python@v2
-      with:
-        python-version: 3.9
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install flake8
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-        if [ -f requirements-test.txt ]; then pip install -r requirements-test.txt; fi
-    - name: Lint with flake8
-      run: |
-        # stop the build if there are Python syntax errors or undefined names
-        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
-    - name: Test
-      run: |
-        python -m unittest discover -s tests/
+      #----------------------------------------------
+      #       check-out repo and set-up python
+      #----------------------------------------------
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+      #----------------------------------------------
+      #        load pip cache if cache exists
+      #----------------------------------------------
+      - uses: actions/cache@v3
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip
+          restore-keys: ${{ runner.os }}-pip
+      #----------------------------------------------
+      #          install and run linters
+      #----------------------------------------------
+      - run: python -m pip install black flake8 isort
+      - run: |
+          flake8 ./finterion
+  test:
+    needs: linting
+    strategy:
+      fail-fast: true
+      matrix:
+        os: [ "ubuntu-latest", "macos-latest" ]
+        python-version: [ "3.8", "3.9", "3.10", "3.11", "3.12" ]
+    runs-on: ${{ matrix.os }}
+    steps:
+      #----------------------------------------------
+      #       check-out repo and set-up python
+      #----------------------------------------------
+      - name: Check out repository
+        uses: actions/checkout@v4
+      - name: Set up python ${{ matrix.python-version }}
+        id: setup-python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      #----------------------------------------------
+      #  -----  install & configure poetry  -----
+      #----------------------------------------------
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+        with:
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+      #----------------------------------------------
+      #       load cached venv if cache exists
+      #----------------------------------------------
+      - name: Load cached venv
+        id: cached-poetry-dependencies
+        uses: actions/cache@v3
+        with:
+          path: .venv
+          key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
+      #----------------------------------------------
+      # install dependencies if cache does not exist
+      #----------------------------------------------
+      - name: Install dependencies
+        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
+        run: poetry install --no-interaction --no-root
+      #----------------------------------------------
+      # install your root project, if required
+      #----------------------------------------------
+      - name: Install library
+        run: poetry install --no-interaction
+      #----------------------------------------------
+      #    add matrix specifics and run test suite
+      #----------------------------------------------
+      - name: Run tests
+        run: |
+          source .venv/bin/activate
+          coverage run -m unittest discover -s tests
+#      #----------------------------------------------
+#      #             upload coverage stats
+#      #----------------------------------------------
+#      - name: Upload coverage
+#        uses: codecov/codecov-action@v3
+#        with:
+#          file: ./coverage.xml
+#          fail_ci_if_error: true

finterion/__init__.py

@@ -1,9 +1,6 @@
 from finterion.exceptions import ClientException
-from finterion.exceptions import ClientException
-from finterion.models import OrderSide, OrderType, Order, Position, Portfolio, \
-    OrderStatus
-from finterion.models import OrderSide, OrderType, Order, Position, Portfolio, \
-    OrderStatus
+from finterion.models import OrderSide, OrderType, Order, Position, \
+    Portfolio, OrderStatus
 from finterion.finterion import Finterion
 
 __all__ = [

finterion/configuration/urls.py

@@ -28,4 +28,3 @@ def get_retrieve_position_url(base_url, position_id):
 
 def get_retrieve_portfolio_url(base_url):
     return f"{base_url}/portfolio"
-

finterion/finterion.py

@@ -36,18 +36,21 @@ def get_orders(
         target_symbol=None,
         symbol=None,
         order_type=None,
-        order_side=None
+        order_side=None,
+        query_params: dict = None
     ):
-        query_params = {
-            "itemized": "true",
-            "environment": self.algorithm["environment"],
-        }
+
+        if query_params is None:
+            query_params = {}
+
+        query_params["itemized"] = "true"
+        query_params["environment"] = self.algorithm["environment"]
 
         if status is not None:
             query_params["status"] = status
 
         if target_symbol is not None:
-            query_params["target_symbol"] = target_symbol
+            query_params["TargetSymbol"] = target_symbol
 
         if symbol is not None:
             query_params["symbol"] = symbol
@@ -59,14 +62,25 @@ def get_orders(
             query_params["side"] = order_side
 
         orders = services.get_orders(
-            self.api_key, query_params, base_url=self.base_url
+            api_key=self.api_key,
+            query_params=query_params,
+            base_url=self.base_url
         )
         logger.debug(f"get_orders response {orders}")
         return orders["items"]
 
-    def get_order(self, order_id):
+    def get_order(self, order_id, query_params: dict = None):
+
+        if query_params is None:
+            query_params = {}
+
+        query_params["environment"] = self.algorithm["environment"]
+
         response = services.get_order(
-            self.api_key, order_id, base_url=self.base_url
+            api_key=self.api_key,
+            order_id=order_id,
+            base_url=self.base_url,
+            query_params=query_params
         )
         logger.info(f"get_order response {response}")
         return response
@@ -84,7 +98,9 @@ def create_order(
 
         }
         response = services.create_order(
-            self.api_key, base_url=self.base_url, data=data
+            api_key=self.api_key,
+            base_url=self.base_url,
+            data=data
         )
         logger.debug(f"create_order response {response}")
         return response
@@ -124,18 +140,29 @@ def create_market_order(self, target_symbol, order_side, amount):
         logger.debug(f"create_market_order response {response}")
         return response
 
-    def get_position(self, position_id):
+    def get_position(self, position_id, query_params: dict = None):
+
+        if query_params is None:
+            query_params = {}
+
+        query_params["environment"] = self.algorithm["environment"]
+
         response = services.get_position(
-            self.api_key, position_id, base_url=self.base_url
+            api_key=self.api_key,
+            position_id=position_id,
+            base_url=self.base_url,
+            query_params=query_params
         )
         logger.debug(f"get_position response {response}")
         return response
 
-    def get_positions(self, symbol=None):
-        query_params = {
-            "itemized": "true",
-            "environment": self.algorithm["environment"],
-        }
+    def get_positions(self, symbol=None, query_params: dict = None):
+
+        if query_params is None:
+            query_params = {}
+
+        query_params["itemized"] = "true"
+        query_params["environment"] = self.algorithm["environment"]
 
         if symbol is not None:
             query_params["symbol"] = symbol
@@ -146,9 +173,14 @@ def get_positions(self, symbol=None):
         logger.debug(f"get_positions response {positions}")
         return positions["items"]
 
-    def get_portfolio(self):
+    def get_portfolio(self, query_params: dict = None):
+        if query_params is None:
+            query_params = {}
+
         response = services.get_portfolio(
-            self.api_key, self.base_url
+            api_key=self.api_key,
+            query_params=query_params,
+            base_url=self.base_url
         )
         logger.debug(f"get_portfolio response {response}")
         return response

finterion/models/order.py

@@ -101,4 +101,4 @@ def get_amount_target_symbol(self):
         return self.amount_target_symbol
 
     def get_amount_trading_symbol(self):
-        return self.amount_trading_symbol
+        return self.amount_trading_symbol

finterion/services.py

@@ -61,10 +61,14 @@ def get_orders(api_key, query_params, base_url):
     return handle_response(response)
 
 
-def get_order(api_key, order_id, base_url):
+def get_order(api_key, order_id, base_url, query_params):
     logger.debug("Getting order")
     url = get_retrieve_order_url(base_url, order_id)
-    response = requests.get(url, headers={"XApiKey": api_key})
+    response = requests.get(
+        url,
+        headers={"XApiKey": api_key},
+        params=query_params
+    )
     return handle_response(response)
 
 
@@ -85,15 +89,22 @@ def get_positions(api_key, query_params, base_url):
     return handle_response(response)
 
 
-def get_position(api_key, position_id, base_url):
+def get_position(api_key, position_id, base_url, query_params):
+
     logger.debug("Getting position")
     url = get_retrieve_position_url(base_url, position_id)
-    response = requests.get(url, headers={"XApiKey": api_key})
+    response = requests.get(
+        url,
+        headers={"XApiKey": api_key},
+        params=query_params
+    )
     return handle_response(response)
 
 
-def get_portfolio(api_key, base_url):
+def get_portfolio(api_key, base_url, query_params):
     logger.debug("Getting portfolio")
     url = get_retrieve_portfolio_url(base_url)
-    response = requests.get(url, headers={"XApiKey": api_key})
+    response = requests.get(
+        url, headers={"XApiKey": api_key}, params=query_params
+    )
     return handle_response(response)

pyproject.toml

@@ -0,0 +1,18 @@
+[tool.poetry]
+name = "finterion-python-client"
+version = "0.7.6"
+description = "Official python client for Finterion"
+authors = ["marcvanduyn <[email protected]>"]
+license = "Apache License 2.0"
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.8"
+requests= "^2.26.0"
+
+[tool.poetry.group.test.dependencies]
+coverage= "7.4.2"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"