Fin-maestro-kin


Summary

This release represents a comprehensive restructuring of the project's module organization and a significant refactoring of existing code to enhance maintainability, readability, and scalability.

Details

1. **Module Reorganization:**
- Restructured the `data_toolkit` module to have separate submodules for different aspects of data processing, namely `nse` and `screener`.
- Each submodule now hosts a single file encapsulating all related functionality, promoting better code organization and management.

2. **Refactoring NSE Operations:**
- Consolidated equities and indices related operations into a unified module named `nse_operations.py`.
- Introduced classes `NSEEquities` and `NSEIndices` within `nse_operations.py` to encapsulate related operations, promoting code modularity and clarity.
- Transferred shared helper methods to a common `Helper` class within `nse_operations.py`, enhancing code reusability and reducing redundancy.

3. **Screener Equities Module:**
- Combined functionalities into a single class named `ScreenerEquities`.
- Incorporated shared helper methods into a common `Helper` class within `screener_equities.py`, streamlining code organization and maintenance.

4. **Sentiment Module:**
- Refactored the `SentimentAnalyzer` module to utilize a class-based approach, encapsulating PCR analysis functionalities within the `SentimentAnalyzer` and `PCR` class.

5. **Trend Detector Module:**
- Refactored the `Trend Detector` module to utilize a class-based approach, encapsulating trend analysis functionalities within the `TrendDetector` class.
- All trend analysis methods, including `signals_generator` and `generate_plot`, are now part of the `TrendDetector` class, promoting better encapsulation and code organization.

6. **New Project Logo:**
- Introduced a new project logo, enhancing visual identity and branding. The updated logo is now reflected in the project's README and release notes.

Docker Image Update
- Pushed an updated Docker image with version v0.2.6, tagged as `latest`, ensuring users have access to the most recent version of the application with the latest enhancements and fixes.

Contributors
- [devfinwiz](https://github.com/devfinwiz)

Impact

- **Codebase Structure**: The restructuring of modules and adoption of a class-based approach improve code organization, making it easier to navigate and maintain.
- **Code Readability**: By encapsulating related functionalities within classes, the codebase becomes more readable and understandable.
- **Maintenance Efficiency**: Shared helper methods and consolidated functionalities reduce redundancy and make maintenance tasks more efficient.
- **Visual Identity**: The new project logo enhances visual identity and branding, contributing to a more professional presentation of the project.

Summary

The v0.2.5 release of Fin-Maestro-Kin introduces new endpoints to support additional data retrieval from Screener.in, enhancing the capabilities of the data-toolkit module. These new endpoints enable users to access a wider range of financial data, empowering them with comprehensive insights into equities listed on the NSE and BSE. Furthermore, the documentation has been updated to reflect these changes, ensuring users have access to accurate and up-to-date information.

Details

1. **New Endpoints**:
- Added new endpoints to support more data from Screener.in, expanding the functionality of the data-toolkit module. The following endpoints have been introduced:
- `/screener-equities/shareholding-pattern`: Retrieve shareholding pattern data for individual stocks.
- `/screener-equities/cash-flow`: Access cash flow statements for in-depth financial analysis.
- `/screener-equities/balance-sheet`: Retrieve balance sheet data to evaluate a company's financial health.
- `/screener-equities/annual-profit-loss`: Access annual profit and loss statements for comprehensive performance analysis.
- `/screener-equities/ratios`: Retrieve various financial ratios to assess key performance indicators.
- `/screener-equities/key-metrics`: Retrieve key financial metrics based on a feature request by Shreyaan.

2. **Documentation Updates**:
- Made appropriate changes to add the new endpoints to the documentation of Fin-Maestro-Kin, ensuring users have access to comprehensive information about the available features and functionalities.

Docker Image Update
- Pushed an updated Docker image with version v0.2.5, tagged as `latest`, ensuring users have access to the most recent version of the application with the latest enhancements and fixes.

Contributors
- [SuyashDM](https://github.com/SuyashDM)
- [devfinwiz](https://github.com/devfinwiz)

Impact

- Users can now access a wider range of financial data from Screener.in, enabling more thorough analysis and evaluation of equities listed on the NSE and BSE.
- The inclusion of key metrics based on a feature request enhances the platform's versatility and responsiveness to user needs.
- Updated documentation ensures that users have accurate and up-to-date information about the platform's features and functionalities, facilitating ease of use and enhancing the overall user experience.

Summary

This release focuses on enhancing endpoint functionality, introducing custom interactive documentation, and improving user experience by redirecting the `/docs` endpoint to the newly developed custom documentation. Additionally, the Docker image has been rebuilt and tagged for version v0.2.4, ensuring users have access to the latest updates.

Details

1. **Endpoint Fix**:
- Fixed the `/equities/most-active-securities` endpoint, resolving issues that prevented it from returning any response. Adjustments were made to accommodate changes in the NSE's API, ensuring reliable and accurate data retrieval.

2. **Custom Interactive Documentation**:
- Designed and released custom interactive and dynamic documentation for Fin-Maestro-Kin using Apidog. The new documentation provides users with an intuitive and user-friendly interface to explore the available endpoints and their functionalities.

3. **Custom Documentation Redirection**:
- Implemented a feature to redirect the `/docs` endpoint to the newly developed custom documentation of Fin-Maestro-Kin. Users accessing the `/docs` endpoint will now be seamlessly redirected to the custom documentation, improving accessibility and usability.

4. **Alternative Documentation Link**:
- Provided an alternative documentation link for users who want to access the documentation in read-only mode without running the server. Users can access the documentation at [https://fin-maestro-kin.apidog.io/](https://fin-maestro-kin.apidog.io/).



Docker Image Update
- Pushed an updated Docker image with version v0.2.4, tagged as `latest`, ensuring users have access to the most recent version of the application with the latest enhancements and fixes.

Impact
- Users can now rely on the fixed `/equities/most-active-securities` endpoint to retrieve accurate data on the most active securities from the NSE.
- The introduction of custom interactive documentation enhances user experience by providing a more intuitive and informative way to explore Fin-Maestro-Kin's capabilities.
- Redirection of the `/docs` endpoint to the custom documentation improves accessibility and ensures that users have access to up-to-date and comprehensive documentation.
- Users have the option to access the documentation in read-only mode via the alternative documentation link, even when the server is not running.

Summary

Fin-Maestro-Kin v0.2.3 introduces new features, enhancements, and infrastructure updates to improve data availability, endpoint functionality, and documentation. Additionally, the Docker image has been updated to ensure users have access to the latest version of the application with the recent enhancements.

Details

New Features
1. Introduced a new data source named "screener" to the "data-toolkit" module, enhancing data availability.
2. Added support for gathering quarterly results for individual stocks from screener.in within the new "screener" submodule.
3. Implemented a new endpoint for the "screener" submodule in the "data-toolkit" module, enabling access to quarterly results data.

Documentation Changes
4. Updated documentation to reflect the new changes and renamed the "Equities" router tag to "NSE Equities" to prevent confusion between Screener Equities and NSE Equities methods.

Testing
5. Conducted thorough testing of all existing endpoints to ensure compatibility and stability with the new changes.

Docker Image Update
6. Pushed an updated Docker image with version v0.2.3, tagged as `latest`, ensuring users have access to the most recent version of the application with the latest enhancements and fixes.

Contributors
- [SuyashDM](https://github.com/SuyashDM)
- [devfinwiz](https://github.com/devfinwiz)

Impact
- Users can now benefit from enhanced data availability with the inclusion of quarterly results gathering from screener.in.
- The new endpoint provides access to quarterly results data, expanding the capabilities of the application for financial analysis and decision-making.
- Documentation updates and renaming of the router tag improve clarity and usability for developers and users.
- Thorough testing ensures that existing functionality remains reliable and stable.
- The updated Docker image simplifies deployment and allows users to access the latest version of the application with the recent enhancements and fixes.

Summary

This release addresses security vulnerabilities and improves endpoint functionality in the Fin Maestro Kin project. Additionally, optimizations have been made to streamline the image building and deployment process.

Details

Security Updates
1. Upgraded `matplotlib` and `pillow` dependencies to address CVE-2024-28219, ensuring the project's security posture remains robust.

Dependency Management
2. Restructured dependency management by moving `pytest` from `[tool.poetry.dependencies]` to `[tool.poetry.dev-dependencies]`. This optimization helps streamline image building and deployment processes by reducing unnecessary dependencies.

Endpoint Fixes
3. Fixed the `/nseindices/history` endpoint to return accurate historical OHLC (Open, High, Low, Close) data instead of random data, improving the reliability and accuracy of financial data retrieval.

Docker Image Update
4. Pushed an updated Docker image with version v0.2.2, tagged as `latest`, ensuring users have access to the most recent version of the application with the latest enhancements and fixes.

Impact
- Users can now benefit from improved security measures with the updated dependencies, ensuring the integrity of financial data processed by the application.
- Streamlined dependency management enhances the efficiency of image building and deployment processes, resulting in faster and more reliable deployments.
- The fixed endpoint ensures that historical financial data retrieved from the `/nseindices/history` endpoint is accurate and reliable, supporting more informed financial analysis and decision-making.
- The availability of the updated Docker image with version v0.2.2 as `latest` on Docker Hub allows for easy deployment and access to the latest features and fixes.

Summary

The v0.2.1 release of Fin-Maestro-Kin brings several improvements to enhance the user experience and stability of the application.

Details

New Features
- Added new endpoints for NSE equities data retrieval:
- `/equities/annual-reports`: Retrieves annual reports for NSE equities.
- `/equities/shareholding-patterns`: Provides shareholding patterns data for NSE equities.
- `/equities/insider-trading`: Offers insights into insider trading activities for NSE equities.
- `/equities/board-meetings`: Fetches details about board meetings related to NSE equities.

Enhancements
- Improved functionality by expanding the range of available NSE equities data.
- Enriched user experience with access to additional insights and information.

Impact
- Users can now access a broader range of NSE equities data, enhancing their market analysis capabilities.
- The improved documentation ensures users can effectively utilize the new endpoints without any confusion or ambiguity.

Docker Image Update
- The Docker image has been updated on Docker Hub with version v0.2.1, providing users with the latest enhancements

For more details, please refer to the [pull request](https://github.com/devfinwiz/Fin-Maestro-Kin/pull/23) for a comprehensive list of changes and additions.