quantvn 0.1.9__tar.gz → 0.1.10__tar.gz

{quantvn-0.1.9/quantvn.egg-info → quantvn-0.1.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: quantvn
-Version: 0.1.9
+Version: 0.1.10
 Summary: QuantVN API Library for Financial Data Analysis
 Author: quantvn
 Classifier: Development Status :: 3 - Alpha

{quantvn-0.1.9 → quantvn-0.1.10}/quantvn/vn/data/stocks.py

@@ -1055,75 +1055,48 @@ class Company:
         return self._provider.ratio_summary()
 
 
-FIN_MAP = {
-    "income_statement": "incomestatement",
-    "balance_sheet": "balancesheet",
-    "cash_flow": "cashflow",
-}
-PERIOD_MAP = {"year": 1, "quarter": 0}
-
-
-# ===== VCI GraphQL Finance Queries =====
-INCOME_STATEMENT_QUERY = """
-query Query($ticker: String!, $period: Int!) {
-  IncomeStatement(ticker: $ticker, period: $period) {
-    id
-    ticker
-    year
-    quarter
-    revenue
-    costOfGoodsSold
-    grossProfit
-    operatingExpenses
-    operatingProfit
-    interestExpense
-    interestIncome
-    otherIncome
-    otherExpense
-    profitBeforeTax
-    incomeTaxExpense
-    netProfit
-    eps
-    __typename
-  }
-}
-""".strip()
-
-BALANCE_SHEET_QUERY = """
-query Query($ticker: String!, $period: Int!) {
-  BalanceSheet(ticker: $ticker, period: $period) {
-    id
-    ticker
-    year
-    quarter
-    totalAssets
-    currentAssets
-    nonCurrentAssets
-    totalLiabilities
-    currentLiabilities
-    nonCurrentLiabilities
-    totalEquity
-    shareCapital
-    retainedEarnings
-    __typename
-  }
+# ===== VCI GraphQL Finance Ratio Query =====
+FINANCE_RATIO_QUERY = """
+fragment Ratios on CompanyFinancialRatio {
+  ticker
+  yearReport
+  lengthReport
+  updateDate
+  revenue
+  revenueGrowth
+  netProfit
+  netProfitGrowth
+  ebitMargin
+  roe
+  roic
+  roa
+  pe
+  pb
+  eps
+  currentRatio
+  cashRatio
+  quickRatio
+  interestCoverage
+  netProfitMargin
+  grossMargin
+  ev
+  issueShare
+  ps
+  pcf
+  bvps
+  evPerEbitda
+  charterCapital
+  dividend
+  ebitda
+  ebit
 }
-""".strip()
 
-CASH_FLOW_QUERY = """
-query Query($ticker: String!, $period: Int!) {
-  CashFlow(ticker: $ticker, period: $period) {
-    id
-    ticker
-    year
-    quarter
-    netCashFromOperating
-    netCashFromInvesting
-    netCashFromFinancing
-    netCashFlow
-    cashAtBeginning
-    cashAtEnd
-    __typename
+query Query($ticker: String!, $period: String!) {
+  CompanyFinancialRatio(ticker: $ticker, period: $period) {
+    ratio {
+      ...Ratios
+    }
+    period
   }
 }
 """.strip()
@@ -1132,84 +1105,19 @@ query Query($ticker: String!, $period: Int!) {
 class _FinanceProvider:
     """Internal provider interface (do not use directly)."""
 
-    def income_statement(
-        self, period: str = "year", lang: str = "vi", dropna: bool = False
-    ) -> pd.DataFrame:  # pragma: no cover
-        raise NotImplementedError
-
-    def balance_sheet(
-        self, period: str = "year", lang: str = "vi", dropna: bool = False
-    ) -> pd.DataFrame:  # pragma: no cover
-        raise NotImplementedError
-
-    def cash_flow(
-        self, period: str = "year", lang: str = "vi", dropna: bool = False
+    def ratio(
+        self, period: str = "Q", dropna: bool = False
     ) -> pd.DataFrame:  # pragma: no cover
         raise NotImplementedError
 
 
 class _VCIFinanceProvider(_FinanceProvider):
-    """Finance provider via VCI GraphQL API."""
+    """Finance provider via VCI GraphQL API - only supports ratio()."""
 
     def __init__(self, symbol: str, *, lang: str = "vi"):
         self.symbol = str(symbol).upper().strip()
         self.lang = lang or "vi"
-        self._cache: Dict[str, Dict[str, Any]] = {}
-
-    def _fetch_finance(self, query: str, report_type: str, period: str) -> pd.DataFrame:
-        """Fetch financial statement via GraphQL and return as DataFrame."""
-        period_val = PERIOD_MAP.get(period, 1)
-
-        cache_key = f"{report_type}_{period}"
-        if cache_key not in self._cache:
-            try:
-                data = _vci_graphql_request(
-                    query=query,
-                    variables={"ticker": self.symbol, "period": period_val},
-                )
-                self._cache[cache_key] = data
-            except Exception as e:
-                raise ValueError(f"Failed to fetch {report_type} from VCI: {e}")
-
-        data = self._cache[cache_key]
-        items = data.get(report_type) or []
-
-        if not isinstance(items, list) or not items:
-            return pd.DataFrame()
-
-        df = pd.DataFrame(items)
-        return df
-
-    def income_statement(
-        self, period: str = "year", lang: str = "vi", dropna: bool = False
-    ) -> pd.DataFrame:
-        """Fetch income statement."""
-        df = self._fetch_finance(INCOME_STATEMENT_QUERY, "IncomeStatement", period)
-        if dropna and not df.empty:
-            df = df.dropna(axis=1, how="all")
-        return df
-
-    def balance_sheet(
-        self, period: str = "year", lang: str = "vi", dropna: bool = False
-    ) -> pd.DataFrame:
-        """Fetch balance sheet."""
-        df = self._fetch_finance(BALANCE_SHEET_QUERY, "BalanceSheet", period)
-        if dropna and not df.empty:
-            df = df.dropna(axis=1, how="all")
-        return df
 
-    def cash_flow(
-        self, period: str = "year", lang: str = "vi", dropna: bool = False
-    ) -> pd.DataFrame:
-        """Fetch cash flow statement."""
-        df = self._fetch_finance(CASH_FLOW_QUERY, "CashFlow", period)
-        if dropna and not df.empty:
-            df = df.dropna(axis=1, how="all")
-        return df
-
-    # ------------------------------------------------------------------
-    # Extra: Financial ratios from VCI (CompanyFinancialRatio)
-    # ------------------------------------------------------------------
     def ratio(self, period: str = "Q", dropna: bool = False) -> pd.DataFrame:
         """
         Fetch financial ratios from VCI CompanyFinancialRatio API.
@@ -1253,60 +1161,17 @@ class _VCIFinanceProvider(_FinanceProvider):
         return df
 
 
-class _TCBSFinanceProvider(_FinanceProvider):
-    """Finance provider via TCBS tcanalysis endpoints (kept as fallback)."""
-
-    def __init__(self, symbol: str):
-        self.symbol = str(symbol).upper().strip()
-
-    def _fetch(
-        self, report: str, period: str = "year", lang: str = "vi", dropna: bool = False
-    ) -> pd.DataFrame:
-        BASE = "https://apipubaws.tcbs.com.vn"
-        ANALYSIS = "tcanalysis"
-        assert report in FIN_MAP, f"Invalid report: {report}"
-        url = f"{BASE}/{ANALYSIS}/v1/finance/{self.symbol}/{FIN_MAP[report]}"
-        params = {"period": PERIOD_MAP.get(period, 1), "size": 1000}
-        data = send_request(url, params=params)
-        df = pd.DataFrame(data)
-        if dropna:
-            df = df.dropna(axis=1, how="all")
-        return df
-
-    def income_statement(
-        self, period: str = "year", lang: str = "vi", dropna: bool = False
-    ) -> pd.DataFrame:
-        return self._fetch("income_statement", period, lang, dropna)
-
-    def balance_sheet(
-        self, period: str = "year", lang: str = "vi", dropna: bool = False
-    ) -> pd.DataFrame:
-        return self._fetch("balance_sheet", period, lang, dropna)
-
-    def cash_flow(
-        self, period: str = "year", lang: str = "vi", dropna: bool = False
-    ) -> pd.DataFrame:
-        return self._fetch("cash_flow", period, lang, dropna)
-
-    def ratio(self, period: str = "Q", dropna: bool = False) -> pd.DataFrame:
-        """
-        TCBS currently does not expose the same CompanyFinancialRatio GraphQL;
-        keep a simple stub that returns empty DataFrame for symmetry.
-        """
-        return pd.DataFrame()
-
-
 class Finance:
     """
-    Public Finance API (stable surface).
+    Public Finance API - Tỷ số tài chính từ VCI GraphQL API.
 
-    Only exposes:
-    - income_statement(period="year", lang="vi", dropna=False)
-    - balance_sheet(period="year", lang="vi", dropna=False)
-    - cash_flow(period="year", lang="vi", dropna=False)
-    - ratio(period="Q" | "Y", dropna=False)    # via VCI CompanyFinancialRatio
+    Chỉ hỗ trợ:
+    - ratio(period="Q" | "Y", dropna=False)    # Tỷ số tài chính từ VCI CompanyFinancialRatio
 
-    Internally uses a provider so you can swap/add APIs later easily.
+    Args:
+        symbol: Mã cổ phiếu (VD: "HPG", "VIC")
+        source: Nguồn dữ liệu (chỉ hỗ trợ "VCI")
+        lang: Ngôn ngữ (mặc định "vi")
     """
 
     def __init__(self, symbol: str, source: str = "VCI", lang: str = "vi"):
@@ -1314,51 +1179,25 @@ class Finance:
         self.source = (source or "VCI").upper()
         self.lang = lang or "vi"
 
-        if self.source == "VCI":
-            self._provider: _FinanceProvider = _VCIFinanceProvider(
-                self.symbol, lang=self.lang
-            )
-        elif self.source == "TCBS":
-            self._provider = _TCBSFinanceProvider(self.symbol)
-        elif self.source == "AUTO":
-            # Try VCI first; if it fails, fallback to TCBS.
-            try:
-                self._provider = _VCIFinanceProvider(self.symbol, lang=self.lang)
-                _ = self._provider.income_statement()
-            except Exception:
-                self._provider = _TCBSFinanceProvider(self.symbol)
-        else:
-            raise ValueError("source must be one of: 'VCI', 'TCBS', 'AUTO'")
-
-    def income_statement(
-        self, period: str = "year", lang: str = "vi", dropna: bool = False
-    ) -> pd.DataFrame:
-        return self._provider.income_statement(period=period, lang=lang, dropna=dropna)
-
-    def balance_sheet(
-        self, period: str = "year", lang: str = "vi", dropna: bool = False
-    ) -> pd.DataFrame:
-        return self._provider.balance_sheet(period=period, lang=lang, dropna=dropna)
+        if self.source != "VCI":
+            raise ValueError("Finance class chỉ hỗ trợ source='VCI' (VCI GraphQL API)")
 
-    def cash_flow(
-        self, period: str = "year", lang: str = "vi", dropna: bool = False
-    ) -> pd.DataFrame:
-        return self._provider.cash_flow(period=period, lang=lang, dropna=dropna)
+        self._provider: _FinanceProvider = _VCIFinanceProvider(
+            self.symbol, lang=self.lang
+        )
 
     def ratio(self, period: str = "Q", dropna: bool = False) -> pd.DataFrame:
         """
-        Financial ratios from VCI CompanyFinancialRatio endpoint.
+        Tỷ số tài chính từ VCI CompanyFinancialRatio endpoint.
 
         Args:
-            period: "Q" (quarterly) or "Y" (yearly), matching the working test script.
+            period: "Q" (quý) hoặc "Y" (năm)
+            dropna: Xóa các cột hoàn toàn trống
+
+        Returns:
+            DataFrame chứa các tỷ số tài chính như revenue, netProfit, roe, pe, pb, etc.
         """
-        # Always go through VCI provider for ratios (this is what the user-tested script uses)
-        vci_provider: _VCIFinanceProvider
-        if isinstance(self._provider, _VCIFinanceProvider):
-            vci_provider = self._provider
-        else:
-            vci_provider = _VCIFinanceProvider(self.symbol, lang=self.lang)
-        return vci_provider.ratio(period=period, dropna=dropna)
+        return self._provider.ratio(period=period, dropna=dropna)
 
 
 # ===================== Reorganized: Fund =====================

{quantvn-0.1.9 → quantvn-0.1.10/quantvn.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: quantvn
-Version: 0.1.9
+Version: 0.1.10
 Summary: QuantVN API Library for Financial Data Analysis
 Author: quantvn
 Classifier: Development Status :: 3 - Alpha

{quantvn-0.1.9 → quantvn-0.1.10}/setup.py

@@ -2,7 +2,7 @@ from setuptools import find_packages, setup
 
 setup(
     name="quantvn",
-    version="0.1.9",
+    version="0.1.10",
     packages=find_packages(),
     install_requires=[
         "requests",