p123api 2.4.0__tar.gz → 2.4.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: p123api
3
- Version: 2.4.0
3
+ Version: 2.4.1
4
4
  Summary: Portfolio123 API wrapper
5
5
  Home-page: https://github.com/portfolio-123/p123api-py
6
6
  Author: Portfolio123
@@ -873,7 +873,7 @@ class Client:
873
873
  self, *, id: Optional[int] = None, factor_id: Optional[int] = None, name: Optional[str] = None
874
874
  ) -> StockFactorInfoResult:
875
875
  """
876
- Stock factor info, only specify factor_id or name
876
+ Retrieves stock factor info, only accepts id or name.
877
877
  """
878
878
  if id is not None:
879
879
  params = {"id": id}
@@ -889,7 +889,7 @@ class Client:
889
889
  def data_series_info(self, *, name: str) -> DataSeriesInfoResult: ...
890
890
  def data_series_info(self, *, id: Optional[int] = None, name: Optional[str] = None) -> DataSeriesInfoResult:
891
891
  """
892
- Data series info, only specify factor_id or name
892
+ Retrieves data series info, only accepts id or name.
893
893
  """
894
894
  return self._req_with_auth_fallback(
895
895
  method="GET", url=self._endpoint + DATA_SERIES_INFO_PATH, params={"name": name} if id is None else {"id": id}
@@ -901,7 +901,12 @@ class Client:
901
901
  def strategy_info(self, *, name: str) -> StrategyInfoResult: ...
902
902
  def strategy_info(self, *, id: Optional[int] = None, name: Optional[str] = None) -> StrategyInfoResult:
903
903
  """
904
- Strategy info, only specify factor_id or name
904
+ Retrieves strategy info, only accepts id or name.
905
+
906
+ :param id: id of the strategy
907
+ :param name: name of the strategy
908
+ :return:
909
+ :rtype: :class:`StrategyInfoResult`
905
910
  """
906
911
  return self._req_with_auth_fallback(
907
912
  method="GET", url=self._endpoint + STRATEGY_INFO_PATH, params={"name": name} if id is None else {"id": id}
@@ -47,7 +47,7 @@ class RankingMethod(IntEnum):
47
47
  NORMAL_DISTRIBUTION = 1
48
48
 
49
49
 
50
- class StrategyInfoResult(TypedDict):
50
+ class StrategyInfoResult(SharedResult):
51
51
  strategyId: int
52
52
  name: str
53
53
  description: str
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: p123api
3
- Version: 2.4.0
3
+ Version: 2.4.1
4
4
  Summary: Portfolio123 API wrapper
5
5
  Home-page: https://github.com/portfolio-123/p123api-py
6
6
  Author: Portfolio123
@@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
5
5
 
6
6
  setuptools.setup(
7
7
  name="p123api",
8
- version="2.4.0",
8
+ version="2.4.1",
9
9
  author="Portfolio123",
10
10
  author_email="info@portfolio123.com",
11
11
  description="Portfolio123 API wrapper",
File without changes
File without changes
File without changes
File without changes
File without changes