financegy 2.0__tar.gz → 3.0__tar.gz

{financegy-2.0 → financegy-3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: financegy
-Version: 2.0
+Version: 3.0
 Summary: Unofficial Python library for accessing GSE (Guyana Stock Exchange) financial data
 Author-email: Ezra Minty <ezranminty@gmail.com>
 License: MIT

{financegy-2.0 → financegy-3.0}/financegy/__init__.py

@@ -23,6 +23,13 @@ from financegy.modules.securities import (
     get_historical_trades,
 )
 
+from financegy.modules.portfolio import (
+    calculate_position_value,
+    calculate_position_return,
+    calculate_position_return_percent,
+    calculate_portfolio_summary,
+)
+
 __all__ = [
     "get_securities",
     "get_security_by_symbol",
@@ -41,6 +48,10 @@ __all__ = [
     "search_securities",
     "get_trades_for_year",
     "get_historical_trades",
+    "calculate_position_value",
+    "calculate_position_return",
+    "calculate_position_return_percent",
+    "calculate_portfolio_summary",
     "clear_cache",
     "save_to_csv",
     "to_dataframe",

{financegy-2.0 → financegy-3.0}/financegy/config.py

@@ -1,4 +1,4 @@
-__version__ = "2.0"
+__version__ = "3.0"
 
 BASE_URL = "https://guyanastockexchangeinc.com"
 HEADERS = {

{financegy-2.0 → financegy-3.0}/financegy/helpers/to_float.py

@@ -1,6 +1,3 @@
-# Function to convert GSE price string to float type
-
-
 def to_float(value):
     if value is None:
         return None

financegy-3.0/financegy/modules/portfolio.py

@@ -0,0 +1,157 @@
+from decimal import Decimal, InvalidOperation, ROUND_HALF_UP
+from financegy.modules import securities
+
+
+def _to_decimal(value, field_name="value"):
+    """
+    Convert strings/numbers to Decimal safely.
+    Handles commas like "3,000.0".
+    """
+    try:
+        clean_value = str(value).replace(",", "")
+        return Decimal(clean_value)
+    except (InvalidOperation, TypeError) as e:
+        raise ValueError(f"Invalid {field_name}: {value}") from e
+
+
+def calculate_position_value(symbol: str, shares):
+    try:
+        shares = _to_decimal(shares, "shares")
+        if shares <= 0:
+            raise ValueError("Shares must be greater than zero")
+
+        last_trade = securities.get_recent_trade(symbol)
+        last_trade_price = _to_decimal(
+            last_trade.get("last_trade_price"), "last_trade_price"
+        )
+
+        position_value = last_trade_price * shares
+
+        return {
+            "last_trade": last_trade,
+            "position_value": str(position_value),
+        }
+
+    except (ValueError, KeyError, TypeError) as e:
+        raise ValueError(f"[calculate_position_value] Invalid input or data: {e}")
+
+
+def calculate_position_return(symbol: str, shares, purchase_price):
+    try:
+        shares = _to_decimal(shares, "shares")
+        purchase_price = _to_decimal(purchase_price, "purchase_price")
+
+        if shares <= 0:
+            raise ValueError("Shares must be greater than zero")
+        if purchase_price <= 0:
+            raise ValueError("Purchase price must be greater than zero")
+
+        last_trade = securities.get_recent_trade(symbol)
+        last_trade_price = _to_decimal(
+            last_trade.get("last_trade_price"), "last_trade_price"
+        )
+
+        position_return = (last_trade_price - purchase_price) * shares
+
+        return {
+            "last_trade": last_trade,
+            "position_return": str(position_return),
+        }
+
+    except (ValueError, KeyError, TypeError) as e:
+        raise ValueError(f"[calculate_position_return] Invalid input or data: {e}")
+
+
+def calculate_position_return_percent(symbol, shares, purchase_price):
+    try:
+        shares = _to_decimal(shares, "shares")
+        purchase_price = _to_decimal(purchase_price, "purchase_price")
+
+        if shares <= 0:
+            raise ValueError("Shares must be greater than zero")
+        if purchase_price <= 0:
+            raise ValueError("Purchase price must be greater than zero")
+
+        last_trade = securities.get_recent_trade(symbol)
+        last_trade_price = _to_decimal(
+            last_trade.get("last_trade_price"), "last_trade_price"
+        )
+
+        return_percent = (
+            (last_trade_price - purchase_price) / purchase_price
+        ) * Decimal("100")
+
+        return {
+            "last_trade": last_trade,
+            "position_return_percent": str(round(return_percent, 2)),
+        }
+
+    except (ValueError, KeyError, TypeError) as e:
+        raise ValueError(
+            f"[calculate_position_return_percent] Invalid input or data: {e}"
+        )
+
+
+def calculate_portfolio_summary(positions: list[dict]):
+    try:
+        total_invested = Decimal("0")
+        total_value = Decimal("0")
+        detailed_positions = []
+
+        for pos in positions:
+            symbol = pos["symbol"]
+            shares = _to_decimal(pos.get("shares"), f"shares for {symbol}")
+            purchase_price = _to_decimal(
+                pos.get("purchase_price"), f"purchase_price for {symbol}"
+            )
+
+            if shares <= 0:
+                raise ValueError(f"Invalid shares for {symbol}")
+            if purchase_price <= 0:
+                raise ValueError(f"Invalid purchase price for {symbol}")
+
+            last_trade = securities.get_recent_trade(symbol)
+            last_trade_price = _to_decimal(
+                last_trade.get("last_trade_price"), f"last_trade_price for {symbol}"
+            )
+
+            invested = shares * purchase_price
+            current_value = shares * last_trade_price
+            gain_loss = current_value - invested
+
+            total_invested += invested
+            total_value += current_value
+
+            detailed_positions.append(
+                {
+                    "symbol": symbol,
+                    "shares": str(shares),
+                    "purchase_price": str(purchase_price),
+                    "last_trade_price": str(last_trade_price),
+                    "invested": str(invested),
+                    "current_value": str(current_value),
+                    "gain_loss": str(gain_loss),
+                }
+            )
+
+        total_gain_loss = total_value - total_invested
+
+        if total_invested != 0:
+            return_percent = (
+                total_gain_loss / total_invested * Decimal("100")
+            ).quantize(Decimal("0.01"), rounding=ROUND_HALF_UP)
+        else:
+            return_percent = Decimal("0.00")
+
+        return {
+            "summary": {
+                "total_invested": str(total_invested),
+                "current_value": str(total_value),
+                "total_gain_loss": str(total_gain_loss),
+                "return_percent": str(return_percent),
+            },
+            "positions": detailed_positions,
+        }
+
+    except (ValueError, KeyError, TypeError) as e:
+        raise ValueError(f"[calculate_portfolio_summary] Invalid portfolio data: {e}")

{financegy-2.0 → financegy-3.0}/financegy.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: financegy
-Version: 2.0
+Version: 3.0
 Summary: Unofficial Python library for accessing GSE (Guyana Stock Exchange) financial data
 Author-email: Ezra Minty <ezranminty@gmail.com>
 License: MIT

{financegy-2.0 → financegy-3.0}/financegy.egg-info/SOURCES.txt

@@ -13,6 +13,7 @@ financegy/core/parser.py
 financegy/core/request_handler.py
 financegy/helpers/safe_text.py
 financegy/helpers/to_float.py
+financegy/modules/portfolio.py
 financegy/modules/securities.py
 financegy/utils/utils.py
 tests/test_securities.py

{financegy-2.0 → financegy-3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "financegy"
-version = "2.0"
+version = "3.0"
 description = "Unofficial Python library for accessing GSE (Guyana Stock Exchange) financial data"
 authors = [{ name = "Ezra Minty", email = "ezranminty@gmail.com" }]
 dependencies = ["requests", "beautifulsoup4", "pandas", "openpyxl"]

{financegy-2.0 → financegy-3.0}/tests/test_securities.py

@@ -91,6 +91,30 @@ def test_search_securities():
     assert isinstance(result, list)
 
 
+def test_calculate_position_value():
+    result = calculate_position_value("ddl", "10")
+    assert isinstance(result, (dict, type(None)))
+
+
+def test_calculate_position_return():
+    result = calculate_position_return("ddl", "10", "31")
+    assert isinstance(result, (dict, type(None)))
+
+
+def test_calculate_position_return_percent():
+    result = calculate_position_return_percent("ddl", "10", "31")
+    assert isinstance(result, dict)
+
+
+def test_calculate_portfolio_summary():
+    positions = [
+        {"symbol": "DTC", "shares": "100", "purchase_price": "300"},
+        {"symbol": "DDL", "shares": "50", "purchase_price": "250"},
+    ]
+    result = calculate_portfolio_summary(positions)
+    assert isinstance(result, dict)
+
+
 def test_to_dataframe():
     result = to_dataframe(get_securities())
     assert isinstance(result, pd.DataFrame)