p123api 1.9.2__tar.gz → 2.0.0__tar.gz

{p123api-1.9.2 → p123api-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: p123api
-Version: 1.9.2
+Version: 2.0.0
 Summary: Portfolio123 API wrapper
 Home-page: https://github.com/portfolio-123/p123api-py
 Author: Portfolio123

{p123api-1.9.2 → p123api-2.0.0}/p123api/client.py

@@ -3,8 +3,7 @@ import requests
 import time
 import pandas
 from string import Template
-import mimetypes
-from typing import List
+from typing import IO, Callable, List, Literal, Optional, Union
 
 
 ENDPOINT = "https://api.portfolio123.com"
@@ -62,9 +61,9 @@ class Client:
         self._token = None
 
         if not isinstance(api_id, str) or not api_id:
-            raise ClientException("api_id needs to be a non empty str")
+            raise ClientException("api_id needs to be a non-empty str")
         if not isinstance(api_key, str) or not api_key:
-            raise ClientException("api_key needs to be a non empty str")
+            raise ClientException("api_key needs to be a non-empty str")
 
         self._auth_params = {"apiId": api_id, "apiKey": api_key, **auth_extra}
         self._session = requests.Session()
@@ -135,7 +134,7 @@ class Client:
         data=None,
         headers=None,
         stop: bool = False,
-    ):
+    ) -> Optional[requests.Response]:
         """
         Request with authentication fallback, used by all requests (except authentication)
         :param name: request action
@@ -524,18 +523,15 @@ class Client:
         :param strategy_id:
         :return:
         """
+
         return self._req_with_auth_fallback(
             name="strategy details",
             method="GET",
             url=self._endpoint + STRATEGY_DETAILS_PATH.substitute(id=strategy_id),
         ).json()
-    
+
     def strategy_transactions(
-        self,
-        strategy_id: int,
-        start: str,
-        end: str,
-        to_pandas=False
+        self, strategy_id: int, start: str, end: str, to_pandas=False
     ):
         """
         Strategy transactions
@@ -544,19 +540,22 @@ class Client:
         :param end: end date in YYYY-MM-DD format
         :return:
         """
+
         ret = self._req_with_auth_fallback(
             name="strategy transactions",
             method="GET",
-            url=self._endpoint + STRATEGY_TRANS_PATH.substitute(id=strategy_id) + f"?start={start}&end={end}",
+            url=self._endpoint + STRATEGY_TRANS_PATH.substitute(id=strategy_id),
+            params=[("start", start), ("end", end)],
         ).json()
         return pandas.DataFrame(ret["trans"]) if to_pandas else ret
-    
+
     def strategy_transaction_import(
         self,
         strategy_id: int,
-        file_path: str,
-        update_existing: bool = False,
-        make_rebal_dt_curr: bool = False,
+        data: Union[str, IO[str]],
+        content_type: Literal["text/csv", "text/tsv"] = "text/csv",
+        update_existing=False,
+        make_rebal_dt_curr=False,
     ):
         """
         Strategy transaction import
@@ -566,22 +565,22 @@ class Client:
         :param make_rebal_dt_curr: if True, the rebalancing date will be set to the current date
         :return:
         """
-        with open(file_path, "rb") as data:
-            get_params = []
-            if update_existing:
-                get_params.append("updateExisting=yes")
-            if make_rebal_dt_curr:
-                get_params.append("makeRebalDtCurr=yes")
-            get_params = "?" + "&".join(get_params) if len(get_params) else ""
-            content_type, _ = mimetypes.guess_type(file_path)
-            headers = {'Content-Type': content_type} if content_type else {}
-            return self._req_with_auth_fallback(
-                name="strategy transaction import",
-                url=self._endpoint + STRATEGY_TRANS_PATH.substitute(id=strategy_id) + get_params,
-                data=data,
-                headers=headers,
-            ).json()
-        
+
+        get_params = []
+        if update_existing:
+            get_params.append(("updateExisting", "1"))
+
+        if make_rebal_dt_curr:
+            get_params.append(("makeRebalDtCurr", "1"))
+
+        return self._req_with_auth_fallback(
+            name="strategy transaction import",
+            url=self._endpoint + STRATEGY_TRANS_PATH.substitute(id=strategy_id),
+            params=get_params,
+            data=data,
+            headers={"Content-Type": content_type},
+        ).json()
+
     def strategy_transaction_delete(
         self,
         strategy_id: int,
@@ -599,12 +598,9 @@ class Client:
             url=self._endpoint + STRATEGY_TRANS_PATH.substitute(id=strategy_id),
             params=params,
         ).json()
-    
+
     def strategy_holdings(
-        self,
-        strategy_id: int,
-        date: str = None,
-        to_pandas=False
+        self, strategy_id: int, date: Optional[str] = None, to_pandas=False
     ):
         """
         Strategy holdings
@@ -612,26 +608,26 @@ class Client:
         :param date: date in YYYY-MM-DD format, if None, current date is used
         :return:
         """
+
+        get_params = [("date", date)] if date is not None else []
+
         ret = self._req_with_auth_fallback(
             name="strategy hldings",
             method="GET",
-            url=self._endpoint + STRATEGY_HOLDINGS_PATH.substitute(id=strategy_id) +
-                (f"?date={date}" if date is not None else ""),
+            url=self._endpoint + STRATEGY_HOLDINGS_PATH.substitute(id=strategy_id),
+            params=get_params,
         ).json()
 
-        return pandas.DataFrame(ret) if to_pandas else ret
-    
-    def strategy_rebalance(
-        self,
-        strategy_id: int,
-        params: dict
-    ):
+        return pandas.DataFrame(ret["holdings"]) if to_pandas else ret
+
+    def strategy_rebalance(self, strategy_id: int, params: dict):
         """
         Strategy rebalance
         :param strategy_id:
         :param params:
         :return:
         """
+
         ret = self._req_with_auth_fallback(
             name="strategy rebalance",
             url=self._endpoint + STRATEGY_REBALANCE_PATH.substitute(id=strategy_id),
@@ -639,21 +635,19 @@ class Client:
         ).json()
 
         return ret
-    
-    def strategy_rebalance_commit(
-        self,
-        strategy_id: int,
-        params: dict
-    ):
+
+    def strategy_rebalance_commit(self, strategy_id: int, params: dict):
         """
         Strategy rebalance commit
         :param strategy_id:
         :param params:
         :return:
         """
+
         ret = self._req_with_auth_fallback(
             name="strategy rebalance commit",
-            url=self._endpoint + STRATEGY_REBALANCE_COMMIT_PATH.substitute(id=strategy_id),
+            url=self._endpoint
+            + STRATEGY_REBALANCE_COMMIT_PATH.substitute(id=strategy_id),
             params=params,
         ).json()
 
@@ -662,7 +656,7 @@ class Client:
     def stock_factor_upload(
         self,
         factor_id: int,
-        file: str,
+        data: Union[str, IO[str]],
         column_separator: str = None,
         existing_data: str = None,
         date_format: str = None,
@@ -673,7 +667,7 @@ class Client:
         """
         Stock factor data upload
         :param factor_id:
-        :param file:
+        :param data:
         :param column_separator: comma, semicolon or tab
         :param existing_data: overwrite, skip or delete
         :param date_format: dd for day, mm for month and yyyy for year, any separator allowed (defaults to yyyy-mm-dd)
@@ -682,34 +676,27 @@ class Client:
         :param ignore_duplicates:
         :return:
         """
-        with open(file, "rb") as data:
-            get_params = []
-            if column_separator is not None:
-                get_params.append(f"columnSeparator={column_separator}")
-            if existing_data is not None:
-                get_params.append(f"existingData={existing_data}")
-            if date_format is not None:
-                get_params.append(f"dateFormat={date_format}")
-            if decimal_separator is not None:
-                get_params.append(f"decimalSeparator={decimal_separator}")
-            if ignore_errors is not None:
-                get_params.append(
-                    "onError={}".format("continue" if ignore_errors else "stop")
-                )
-            if ignore_duplicates is not None:
-                get_params.append(
-                    "onDuplicates={}".format(
-                        "continue" if ignore_duplicates else "stop"
-                    )
-                )
-            get_params = "?" + "&".join(get_params) if len(get_params) else ""
-            return self._req_with_auth_fallback(
-                name="stock factor data upload",
-                url=self._endpoint
-                + STOCK_FACTOR_UPLOAD_PATH.substitute(id=factor_id)
-                + get_params,
-                data=data,
-            ).json()
+        get_params = []
+        if column_separator is not None:
+            get_params.append(("columnSeparator", column_separator))
+        if existing_data is not None:
+            get_params.append(("existingData", existing_data))
+        if date_format is not None:
+            get_params.append(("dateFormat", date_format))
+        if decimal_separator is not None:
+            get_params.append(("decimalSeparator", decimal_separator))
+        if ignore_errors is not None:
+            get_params.append(("onError", "continue" if ignore_errors else "stop"))
+        if ignore_duplicates is not None:
+            get_params.append(
+                ("onDuplicates", "continue" if ignore_duplicates else "stop")
+            )
+        return self._req_with_auth_fallback(
+            name="stock factor data upload",
+            url=self._endpoint + STOCK_FACTOR_UPLOAD_PATH.substitute(id=factor_id),
+            params=get_params,
+            data=data,
+        ).json()
 
     def stock_factor_create_update(self, params: dict):
         """
@@ -738,7 +725,7 @@ class Client:
     def data_series_upload(
         self,
         series_id: int,
-        file: str,
+        data: Union[str, IO[str]],
         existing_data: str = None,
         date_format: str = None,
         decimal_separator: str = None,
@@ -758,34 +745,27 @@ class Client:
         :param contains_header_row:
         :return:
         """
-        with open(file, "rb") as data:
-            get_params = []
-            if existing_data is not None:
-                get_params.append(f"existingData={existing_data}")
-            if date_format is not None:
-                get_params.append(f"dateFormat={date_format}")
-            if decimal_separator is not None:
-                get_params.append(f"decimalSeparator={decimal_separator}")
-            if ignore_errors is not None:
-                get_params.append(
-                    "onError={}".format("continue" if ignore_errors else "stop")
-                )
-            if ignore_duplicates is not None:
-                get_params.append(
-                    "onDuplicates={}".format(
-                        "continue" if ignore_duplicates else "stop"
-                    )
-                )
-            if contains_header_row is not None:
-                get_params.append(f"headerRow={contains_header_row}")
-            get_params = "?" + "&".join(get_params) if len(get_params) else ""
-            return self._req_with_auth_fallback(
-                name="data series upload",
-                url=self._endpoint
-                + DATA_SERIES_UPLOAD_PATH.substitute(id=series_id)
-                + get_params,
-                data=data,
-            ).json()
+        get_params = []
+        if existing_data is not None:
+            get_params.append(("existingData", existing_data))
+        if date_format is not None:
+            get_params.append(("dateFormat", date_format))
+        if decimal_separator is not None:
+            get_params.append(("decimalSeparator", decimal_separator))
+        if ignore_errors is not None:
+            get_params.append(("onError", "continue" if ignore_errors else "stop"))
+        if ignore_duplicates is not None:
+            get_params.append(
+                ("onDuplicates", "continue" if ignore_duplicates else "stop")
+            )
+        if contains_header_row is not None:
+            get_params.append(("headerRow", contains_header_row))
+        return self._req_with_auth_fallback(
+            name="data series upload",
+            url=self._endpoint + DATA_SERIES_UPLOAD_PATH.substitute(id=series_id),
+            params=get_params,
+            data=data,
+        ).json()
 
     def data_series_create_update(self, params: dict):
         """
@@ -870,7 +850,7 @@ class Client:
         ).json()
 
 
-def req_with_retry(req, max_tries=None, **kwargs):
+def req_with_retry(req: Callable[..., requests.Response], max_tries=None, **kwargs):
     tries = 0
     if max_tries is None:
         max_tries = 5

{p123api-1.9.2 → p123api-2.0.0}/p123api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: p123api
-Version: 1.9.2
+Version: 2.0.0
 Summary: Portfolio123 API wrapper
 Home-page: https://github.com/portfolio-123/p123api-py
 Author: Portfolio123

{p123api-1.9.2 → p123api-2.0.0}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
 
 setuptools.setup(
     name="p123api",
-    version="1.9.2",
+    version="2.0.0",
     author="Portfolio123",
     author_email="info@portfolio123.com",
     description="Portfolio123 API wrapper",