Fin-maestro-kin

Summary

This release introduces a new method for index symbols retrieval and a corresponding endpoint in the NSE Data Toolkit module. Here are the key changes:

1. New Method Added for Index Symbols Retrieval:
- Implemented a new method in `nse_indices.py` to fetch the list of index symbols from an external URL.
- The method provides an efficient way to retrieve index symbols for further analysis and data processing.

2. New Endpoint Added:
- Added a new endpoint `GET /nseindices/index-symbols` in the API to retrieve the list of index symbols.

Details

New Method for Index Symbols Retrieval
- Added a new method `fetch_index_symbols` in `nse_indices.py`.
- This method fetches the list of index symbols from an external URL.
- The retrieved index symbols can be used for various analytical and data visualization purposes.

New Endpoint for Index Symbols Retrieval
- Implemented a new endpoint `GET /nseindices/index-symbols` in the API.
- This endpoint returns the list of index symbols available in the NSE Data Toolkit.

Impact
- Users can now efficiently retrieve index symbols data using the newly introduced method and endpoint.

Summary:

This release introduces enhancements to the NSE Data Toolkit API, focusing on improved documentation organization and the addition of a new endpoint for fetching stock symbols/tickers.

Details:

1. **Categorization of Endpoints on Swagger:**
- Implemented categorization of endpoints on the Swagger documentation.
- Endpoints are now organized into logical groups, enhancing the clarity and usability of the API documentation.
- **Contributor:** [SuyashDM](https://github.com/SuyashDM)

2. **New Endpoint to Fetch Stock Symbols/Tickers:**
- Added a new method in `nse_equities.py` to retrieve a list of stock symbols/tickers from the NSE API.
- The endpoint provides users with access to essential information for equities trading and analysis.

Impact:

- Users interacting with the API documentation will benefit from improved navigation and organization, resulting in a more efficient browsing experience.
- Developers integrating with the API can leverage the new endpoint to retrieve stock symbols/tickers programmatically, facilitating market analysis and trading operations.

Summary:

This release introduces significant enhancements to the NSE Data Toolkit module, focusing on the retrieval of essential data for equities and indices.

Details:

New Methods Added:

- **Corporate Actions Retrieval**: Introduced a method in `nse_equities.py` to fetch corporate actions data for equities from the NSE API.
- **India VIX Data Retrieval**: Implemented a method in `nse_indices.py` to obtain historical India VIX data from the NSE API.

Introduction of Helper File:

A new helper file, `helper.py`, has been added within the `data_toolkit/nse` package. This file contains utility methods to assist in data retrieval and processing tasks.

Impact:

These enhancements expand the capabilities of the NSE Data Toolkit, empowering users to access and analyze additional types of financial data efficiently.

Summary:

- Moved endpoints responsible for PCR data gathering for indices and stocks from `pcr_data.py` to `nse_indices.py` and `nse_equities.py` respectively.
- Improved the naming of endpoints for enhanced clarity and consistency.

Details:

- **PCR Data Gathering:**
- The endpoints handling PCR (Put-Call Ratio) data gathering for both indices and stocks have been relocated to dedicated files:
- Indices PCR data gathering now resides in `nse_indices.py`.
- Stocks PCR data gathering now resides in `nse_equities.py`.
- This change improves the organization and maintainability of the codebase by grouping related functionality together.

- **Endpoint Naming Improvement:**
- Renamed endpoints for better clarity and consistency in usage.
- Updated endpoint names align with industry standards and enhance the user experience when interacting with the API.

Impact:
- Users integrating with the API may need to update their endpoint URLs to reflect the new file locations.
- Endpoint naming improvements may require minor adjustments to client-side code or documentation to ensure compatibility.

**Summary:**
This release introduces a minor update to the project's README file on PyPI. The update includes the addition of a basic template structure for the README file to facilitate future documentation efforts.

**Changes:**

- **README Template Added:**
- Added a basic template structure to the README file to serve as a foundation for future documentation efforts.

**Impact:**
While this update does not introduce significant changes to the project's functionality, it lays the groundwork for improved documentation and user guidance in future releases. The addition of a README template provides a structured framework for documenting the project's features and usage.

**Package Details:**
- **Package Name:** fin-maestro-kin
- **Installation Command:** `pip install fin-maestro-kin`

**Action Required:**
- Review the updated README file and provide feedback on the proposed template structure.
- Consider contributing to the documentation efforts by adding content to the README file as the project progresses.

**Summary:**
This release focuses on upgrading the FastAPI version used in the project from 0.108.0 to 0.109.2. This update includes several enhancements, bug fixes, and performance improvements provided by FastAPI's latest version.

**Changes:**

- **FastAPI Version Upgrade:**
- Upgraded FastAPI version from 0.108.0 to 0.109.2.
- Incorporated new features and improvements introduced in the updated FastAPI version.

**Impact:**
The upgrade to FastAPI version 0.109.2 brings enhanced functionality, improved performance, and bug fixes, ensuring a more robust and efficient API framework for the project.

**Action Required:**
- Ensure compatibility with the updated FastAPI version in your development environment.
- Test the application thoroughly to identify and address any potential compatibility issues or regressions introduced by the FastAPI upgrade.