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

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,,