financegy 1.5__py3-none-any.whl → 3.0__py3-none-any.whl

financegy-3.0.dist-info/METADATA

@@ -0,0 +1,201 @@
+Metadata-Version: 2.4
+Name: financegy
+Version: 3.0
+Summary: Unofficial Python library for accessing GSE (Guyana Stock Exchange) financial data
+Author-email: Ezra Minty <ezranminty@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/xbze3/financegy
+Project-URL: Issues, https://github.com/xbze3/financegy/issues
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: beautifulsoup4
+Requires-Dist: pandas
+Requires-Dist: openpyxl
+Dynamic: license-file
+
+# 🏦 FinanceGY
+
+**FinanceGY** is an unofficial Python library for accessing financial data from the **Guyana Stock Exchange (GSE)**. It provides a simple and consistent interface for retrieving information on traded securities, recent trade data, and session details, all programmatically.
+
+---
+
+## Installation
+
+```bash
+pip install financegy
+```
+
+---
+
+## Quick Start
+
+```python
+import financegy
+
+# --------------------------
+# Core Data Retrieval
+# --------------------------
+
+# Get a list of all traded securities
+securities = financegy.get_securities()
+
+# Get the full name of a security by its ticker symbol
+security_name = financegy.get_security_by_symbol("DDL")
+
+# Get the most recent trade data for a security
+recent_trade = financegy.get_recent_trade("DDL")
+
+# Get the most recent closing/last trade price (same most-recent session)
+previous_close = financegy.get_previous_close("DDL")
+
+# Get absolute price change vs previous session close
+price_change = financegy.get_price_change("DDL")
+
+# Get percent price change vs previous session close
+price_change_percent = financegy.get_price_change_percent("DDL")
+
+# Get all trade data for the most recent year (for the security)
+recent_year_trades = financegy.get_security_recent_year("DDL")
+
+# Get trade data for a specific trading session (all securities)
+session_trades = financegy.get_session_trades("1136")
+
+# Get trade data for a specific security in a session
+security_session_trade = financegy.get_security_session_trade("DDL", "1136")
+
+# Search for securities by name or symbol
+search_results = financegy.search_securities("DDL")
+
+# Get all trades for a specific year
+year_trades = financegy.get_trades_for_year("DDL", "2019")
+
+# Get historical trades within a date range — supports: yyyy / mm/yyyy / dd/mm/yyyy
+historical_trades = financegy.get_historical_trades(
+    symbol="DDL",
+    start_date="01/06/2020",
+    end_date="01/2022"
+)
+
+# --------------------------
+# Analytics / Calculations
+# --------------------------
+
+# Get the latest session info (dict returned from most recent trade)
+latest_session = financegy.get_latest_session_for_symbol("DDL")
+
+# Average last traded price over a session range (inclusive)
+avg_price_range = financegy.get_sessions_average_price("DDL", "1100", "1136")
+
+# Average last traded price over the last N sessions (ending at latest session)
+avg_price_latest = financegy.get_average_price("DDL", 30)
+
+# Volatility over the last N sessions (weekly log-return volatility + annualized)
+volatility = financegy.get_sessions_volatility("DDL", 30)
+
+# Year-to-date high and low traded prices
+ytd_high_low = financegy.get_ytd_high_low("DDL")
+
+# --------------------------
+# Utilities
+# --------------------------
+
+# Convert results to a DataFrame
+df = financegy.to_dataframe(securities)
+
+# Export to CSV / Excel
+financegy.save_to_csv(securities, filename="securities.csv", silent=True)
+financegy.save_to_excel(securities, filename="securities.xlsx", silent=True)
+
+# Clear FinanceGY cache directory
+financegy.clear_cache(silent=True)
+```
+
+---
+
+## API Reference
+
+### Core Data Retrieval
+
+| Function                                              | Description                                                                                           |
+| ----------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
+| `get_securities()`                                    | Returns all currently traded securities on the GSE.                                                   |
+| `get_security_by_symbol(symbol)`                      | Returns the full security name for a ticker symbol (e.g., `"DDL"` → `"Demerara Distillers Limited"`). |
+| `get_recent_trade(symbol)`                            | Returns the most recent trade information for the given security.                                     |
+| `get_security_recent_year(symbol)`                    | Returns all trade data for the most recent year available for the selected security.                  |
+| `get_session_trades(session)`                         | Returns trade data for **all** securities during a specific trading session.                          |
+| `get_security_session_trade(symbol, session)`         | Returns trade data for a **specific** security during a specific session.                             |
+| `search_securities(query)`                            | Searches securities whose names or ticker symbols match the given query (partial match).              |
+| `get_trades_for_year(symbol, year)`                   | Returns all trade records for a specific security during a given year.                                |
+| `get_historical_trades(symbol, start_date, end_date)` | Returns historical trades within the specified date range (`dd/mm/yyyy`, `mm/yyyy`, or `yyyy`).       |
+
+### Analytics / Calculation Functions
+
+| Function                                                         | Description                                                                                      |
+| ---------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
+| `get_previous_close(symbol)`                                     | Returns the most recent closing/last trade price for the security.                               |
+| `get_price_change(symbol)`                                       | Returns absolute price difference between the most recent trade and the previous session close.  |
+| `get_price_change_percent(symbol)`                               | Returns percent price change between the most recent trade and the previous session close.       |
+| `get_latest_session_for_symbol(symbol)`                          | Returns the latest trade dict for the symbol (includes the latest `session`).                    |
+| `get_sessions_average_price(symbol, session_start, session_end)` | Returns the average last traded price over a session range (inclusive).                          |
+| `get_average_price(symbol, session_number)`                      | Returns the average last traded price over the last **N** sessions ending at the latest session. |
+| `get_sessions_volatility(symbol, session_number)`                | Returns volatility over the last **N** sessions using log returns (weekly + annualized).         |
+| `get_ytd_high_low(symbol)`                                       | Returns year-to-date highest and lowest traded prices for the security.                          |
+
+### Utilities
+
+| Function                                                               | Description                                                     |
+| ---------------------------------------------------------------------- | --------------------------------------------------------------- |
+| `to_dataframe(data)`                                                   | Converts FinanceGY list/dict results into a `pandas.DataFrame`. |
+| `save_to_csv(data, filename="output.csv", path=None, silent=False)`    | Saves data to a CSV file.                                       |
+| `save_to_excel(data, filename="output.xlsx", path=None, silent=False)` | Saves data to an Excel file.                                    |
+| `clear_cache(silent=False)`                                            | Completely clears the FinanceGY cache directory.                |
+
+---
+
+## Caching System
+
+FinanceGY includes a lightweight local caching system designed to speed up repeated requests and reduce unnecessary calls.
+
+Whenever you call a data retrieval function (such as `get_securities()` or `get_recent_trade()`), FinanceGY automatically checks whether a cached response already exists for that specific query:
+
+- If a valid cache file (less than 7 days old since sessions are held once per week) is found, the result is returned instantly from the cache.
+- If the cache is missing, disabled, or older than one week, FinanceGY fetches fresh data from the GSE and updates the cache automatically.
+
+All cache files are stored in a local `cache/` directory as small JSON files containing the retrieved data and a timestamp.
+
+You can manually clear all cached data at any time:
+
+```python
+import financegy
+
+financegy.clear_cache()
+```
+
+This will delete all cached files and force the next data request to fetch fresh data directly from the source.
+
+If you prefer to bypass the cache for a specific call, simply pass `use_cache=False` to any function. For example:
+
+```python
+# Force a fresh fetch from the GSE, ignoring cached data
+recent_trade = financegy.get_recent_trade("DDL", use_cache=False)
+```
+
+By default, caching is enabled for all supported functions unless explicitly turned off.
+
+---
+
+## License
+
+This project is licensed under the **MIT License**
+
+---
+
+## Example Use Case
+
+```python
+import financegy
+
+ddl_recent = financegy.get_security_recent("DDL")
+print(ddl_recent)
+```

financegy-3.0.dist-info/RECORD

@@ -0,0 +1,15 @@
+financegy/__init__.py,sha256=SY0WDJGydD-9fU9i3Yff2WI8mrreGfFy22XSlSEPlJI,1664
+financegy/config.py,sha256=lAuUzlFaa7qQ4CN2LVHRQ93LQ7jbhaC95Voz6PpGh_k,193
+financegy/cache/cache_manager.py,sha256=c-VW3tk2A-Z-hMrTN4d_OOB6Zse9r-hrAcNhpBY6Sjo,1840
+financegy/core/parser.py,sha256=tU6bFDVTW6ztKeDWQBL7RuxJGTIjeGuMk3SUF_lTWKY,18181
+financegy/core/request_handler.py,sha256=g0C0R-nvIvicAhxnCEAtTU8buVtzUn8725EERvBA6ZU,276
+financegy/helpers/safe_text.py,sha256=pskFh-ejjVAR8f_NBL5x3EwuBtd9OocAKN6ozqNDPhs,141
+financegy/helpers/to_float.py,sha256=VVE3fkHzIE2un6zD50au_U2b_Luh13p3-T84fxEE6Xo,191
+financegy/modules/portfolio.py,sha256=HFWw1FenJ_pABQhF7OlpP6OXuLCiyQBmwyXLrj-g6WQ,5483
+financegy/modules/securities.py,sha256=_1f0-aZI7xWH5ndk5KSRVkqage3OpMbxaIod4W1xBy8,14687
+financegy/utils/utils.py,sha256=mqbjZ4em_a7rZyDgCjFswspEIL_WUPOXa8siAuxZuoY,1434
+financegy-3.0.dist-info/licenses/LICENSE,sha256=HGLhx0fI215whUzIvTFdFivB447d_IdIIIRncUCQaEs,1088
+financegy-3.0.dist-info/METADATA,sha256=XwV5KpXYnrTusYQKWzHnFwgD4KFNWWggmFwBD1kaKzM,9674
+financegy-3.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+financegy-3.0.dist-info/top_level.txt,sha256=TpdYDxtK61m5xnvvzbqnDVJ82gphEqxnXN_Ur8rjvxQ,10
+financegy-3.0.dist-info/RECORD,,

{financegy-1.5.dist-info → financegy-3.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.9.0)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

financegy-1.5.dist-info/METADATA

@@ -1,141 +0,0 @@
-Metadata-Version: 2.4
-Name: financegy
-Version: 1.5
-Summary: Unofficial Python library for accessing GSE (Guyana Stock Exchange) financial data
-Author-email: Ezra Minty <ezranminty@gmail.com>
-License: MIT
-Project-URL: Homepage, https://github.com/xbze3/financegy
-Project-URL: Issues, https://github.com/xbze3/financegy/issues
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: requests
-Requires-Dist: beautifulsoup4
-Requires-Dist: pandas
-Requires-Dist: openpyxl
-Dynamic: license-file
-
-# 🏦 FinanceGY
-
-**FinanceGY** is an unofficial Python library for accessing financial data from the **Guyana Stock Exchange (GSE)**. It provides a simple and consistent interface for retrieving information on traded securities, recent trade data, and session details, all programmatically.
-
----
-
-## Installation
-
-```bash
-pip install financegy
-```
-
----
-
-## Quick Start
-
-```python
-import financegy
-
-# Get a list of all traded securities
-securities = financegy.get_securities()
-
-# Get the name of a security by its ticker symbol
-security_name = financegy.get_security_by_symbol("DDL")
-
-# Get the most recent trade data for a security
-recent_trade = financegy.get_recent_trade("DDL")
-
-# Get all trade data for the most recent year
-recent_year = financegy.get_security_recent_year("DDL")
-
-# Get trade data for a specific trading session
-session_trades = financegy.get_session_trades("1136")
-
-# Get session trade data for a specific security
-security_session_trade = financegy.get_security_session_trade("DDL", "1136")
-
-# Search for securities by name or symbol
-search_results = financegy.search_securities("DDL")
-
-# Get all trades for a given year
-year_trades = financegy.get_trades_for_year("DDL", "2019")
-
-# Get historical trades within a date range - (yyyy) / (mm/yyyy) / (dd/mm/yyyy)
-historical_trades = financegy.get_historical_trades(
-    symbol="DDL",
-    start_date="01/06/2020",
-    end_date="01/2022"
-)
-```
-
----
-
-## Data Retrieval
-
-| Function                                                             | Description                                                                                                            |
-| -------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
-| `get_securities()`                                                   | Returns a list of all currently traded securities on the GSE.                                                          |
-| `get_security_by_symbol(symbol: str)`                                | Retrieves the full name of a security using its ticker symbol (e.g., `"DDL"` → `"Demerara Distillers Limited"`).       |
-| `get_recent_trade(symbol: str)`                                      | Returns the most recent trade information for the given security.                                                      |
-| `get_security_recent_year(symbol: str)`                              | Fetches all trade data for the most recent year of the selected security.                                              |
-| `get_session_trades(session: str)`                                   | Retrieves trade data for all securities during a specific trading session.                                             |
-| `get_security_session_trade(symbol: str, session: str)`              | Retrieves trade data for a specific security in a given trading session.                                               |
-| `search_securities(query: str)`                                      | Searches for securities whose names or ticker symbols match the given query.                                           |
-| `get_trades_for_year(symbol: str, year: str)`                        | Returns all trade records for a specific security during a given year.                                                 |
-| `get_historical_trades(symbol: str, start_date: str, end_date: str)` | Fetches historical trade data for a security within the specified date range (`dd/mm/yyyy`, `mm/yyyy`, `yyyy` format). |
-
----
-
-### Data Utilities
-
-| Function                                                               | Description                                                                                                                                              |
-| ---------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `to_dataframe(data)`                                                   | Converts a list (or dictionary) of trade data into a Pandas DataFrame for easy analysis. Raises `TypeError` if the data is not properly formatted.       |
-| `save_to_csv(data, filename: str = "output.csv", path: str = None)`    | Saves the given data to a CSV file. By default, the file is saved to the current working directory. Returns `True` after saving successfully.            |
-| `save_to_excel(data, filename: str = "output.xlsx", path: str = None)` | Saves the given data to an Excel `.xlsx` file. By default, the file is saved to the current working directory. Returns `True` after saving successfully. |
-
----
-
-## Caching System
-
-FinanceGY includes a lightweight local caching system designed to speed up repeated requests and reduce unnecessary calls.
-
-Whenever you call a data retrieval function (such as `get_securities()` or `get_recent_trade()`), FinanceGY automatically checks whether a cached response already exists for that specific query:
-
--   If a valid cache file (less than 7 days old since sessions are held once per week) is found, the result is returned instantly from the cache.
--   If the cache is missing, disabled, or older than one week, FinanceGY fetches fresh data from the GSE and updates the cache automatically.
-
-All cache files are stored in a local `cache/` directory as small JSON files containing the retrieved data and a timestamp.
-
-You can manually clear all cached data at any time:
-
-```python
-import financegy
-
-financegy.clear_cache()
-```
-
-This will delete all cached files and force the next data request to fetch fresh data directly from the source.
-
-If you prefer to bypass the cache for a specific call, simply pass `use_cache=False` to any function. For example:
-
-```python
-# Force a fresh fetch from the GSE, ignoring cached data
-recent_trade = financegy.get_recent_trade("DDL", use_cache=False)
-```
-
-By default, caching is enabled for all supported functions unless explicitly turned off.
-
----
-
-## License
-
-This project is licensed under the **MIT License**
-
----
-
-## Example Use Case
-
-```python
-import financegy
-
-ddl_recent = financegy.get_security_recent("DDL")
-print(ddl_recent)
-```

financegy-1.5.dist-info/RECORD

@@ -1,12 +0,0 @@
-financegy/__init__.py,sha256=j938wP-4t3qnjgUOgLzr4lL9CevuNMGH10DWgDd-4Ew,929
-financegy/config.py,sha256=SD5LpUVZvthUJEN2KxInRzoOLZCgSMXHV-tc1kKSPt8,193
-financegy/cache/cache_manager.py,sha256=l2J7Fj3g0EnkJLGeIMuaslwFI9-6Ipmf4PHJLUMphAU,1859
-financegy/core/parser.py,sha256=Cuej95KUp_FJL58cskzdeaA2DNBDPR2v6JCo5jCZlKk,11071
-financegy/core/request_handler.py,sha256=g0C0R-nvIvicAhxnCEAtTU8buVtzUn8725EERvBA6ZU,276
-financegy/modules/securities.py,sha256=PNEqfot_cqneO0j4muRfYC5sbCUaZaJoKiq1exBXSz4,5233
-financegy/utils/utils.py,sha256=l0oOE36Br8A9uZp_1Cq82LZCKnZLEvLGCbExJzCkhA0,1328
-financegy-1.5.dist-info/licenses/LICENSE,sha256=HGLhx0fI215whUzIvTFdFivB447d_IdIIIRncUCQaEs,1088
-financegy-1.5.dist-info/METADATA,sha256=8XkenLyrcfzT04WHrM5YHudRRuFcdOGcPmR4eyMqtEw,6923
-financegy-1.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-financegy-1.5.dist-info/top_level.txt,sha256=TpdYDxtK61m5xnvvzbqnDVJ82gphEqxnXN_Ur8rjvxQ,10
-financegy-1.5.dist-info/RECORD,,