#1 : Basic Message generation in cQube

[invinayak007]

Description

This ticket involves the implementation of a Basic Message Generation system in cQube, focusing on understanding cQube's workings, concepts, and flow. The process includes rudimentary threshold checks based on aggregate results, generating signals, and triggering messages added to the message queue.

Key Features

• Understanding cQube:
  In-depth exploration of cQube's workings, concepts, and overall flow.
• Threshold Checks:
  Implementation of basic threshold checks using aggregate results.
• Signal Generation:
  Generation of signals based on the outcomes of the threshold checks.
• Message Triggering:
  Triggering of messages corresponding to generated signals.
• Message Queue Management:
  Efficient addition of messages to the message queue for further processing.

Learning Path

• Complexity: Moderate
• Risk/Exploratory: Low
• Skills Required: Python, Familiarity with cQube, understanding of threshold checks, and message queue handling and preferably Python

Project Setup

• Gain a thorough understanding of cQube's architecture and workflow.
• Set up the development environment with the necessary tools and libraries.
• Fork the project repository from the designated GitHub repository.
• Clone the forked repository to the local environment.
• Configure environment variables and any specific settings needed for the project.
• For detailed instructions, refer to https://cqube.sunbird.org/

Acceptance Criteria

• Successful implementation of basic message generation in cQube.
• Correct functioning of rudimentary threshold checks and signal generation.
• Proper triggering of messages added to the message queue

Out of Scope Elements

• Complex message processing or routing.
• Integration with external systems beyond the message queue.

Key Milestones

• Understanding cQube and its workflow.
• Implementation of basic threshold checks.
• Successful signal generation based on threshold outcomes.
• Triggering of messages and their addition to the message queue.
• Testing and debugging for a fully functional system.

Product Name

cQube

Project Name

cQube - Create a cross drill-down service and a breadcrumb service for reports

Organization Name

Tibil computer solutions Pvt Ltd

Tech Skills Needed

Python

Category

Feature

Mentor(s)

@invinayak007

Complexity

High

[c4gt-community-support]

Hi!
Important Details - These following details are helpful for contributors to effectively identify and contribute to tickets.

• Domain - Area of governance
• Sub-Category - Please mention the sub-category if any for the ticket

Please update the ticket

[Y3ABHISHEK]

@Shruti3004 @invinayak007 I have gone through the problem & feel that I have the required skillset to contribute. Can I work on this?

[invinayak007]

@Y3ABHISHEK, Thanks for your interest. Can you DM me @invinayak on Discord.

[itsdivya1309]

Is this issue still open? I would like to work on this.
Thanks

[invinayak007]

@itsdivya1309 Thanks for your interest. Can you DM me @invinayak on Discord.

[SanjayRam07]

hello @invinayak007 Can I work on this issue?
Is it still available?

[invinayak007]

Please note that, if you want to work on this ticket, please document your approach and send it for review.

[SanjayRam07]

@invinayak007 , here's my workflow.

Step 1: Understanding cQube

1. Explore cQube's Workflow:
   • Study the architecture and workflow of cQube.
   • Understand how data is processed, aggregated, and used within the system.

Step 2: Project Setup

2. Set Up Development Environment:

   • Install the necessary tools and libraries required for cQube development.

3. Fork and Clone Repository:

   • Fork the project repository from the designated GitHub repository.
   • Clone the forked repository to your local environment.

4. Configure Environment Variables:

   • Set up environment variables and configure any specific settings needed for the project.

Step 3: Basic Threshold Checks

5. Implement Basic Threshold Checks:
   • Identify key aggregate results that require threshold checks.
   • Implement basic threshold checks using Python based on the identified aggregates.

Step 4: Signal Generation

6. Generate Signals:
   • Based on the outcomes of the threshold checks, implement the generation of signals.
   • Understand the criteria for signaling and generate signals accordingly.

Step 5: Message Triggering and Queue Management

7. Trigger Messages:

   • Develop the logic to trigger messages based on the generated signals.

8. Manage Message Queue:

   • Efficiently add triggered messages to the message queue for further processing.

Step 6: Testing and Debugging

9. Test System Functionality:

   • Conduct thorough testing of the implemented system.
   • Test each component, including threshold checks, signal generation, and message triggering.

10. Debugging:

    • Address any issues or bugs identified during testing.

Step 7: Documentation

11. Document Implementation:
    • Update code comments for clarity.
    • Document how the Basic Message Generation system works.
    • Provide instructions for developers who might work on this system in the future.

Step 8: Review with Mentor

12. Code Review:
    • Have the implemented code reviewed by the mentor.
    • Incorporate any feedback or suggestions provided by the mentor.

Step 9: Finalization

13. Final Adjustments:

    • Make any final adjustments based on the feedback received.

14. Integration with the Main Codebase:

    • Ensure successful integration of the Basic Message Generation system with the main cQube codebase.

[invinayak007]

I have assigned this ticket to @SanjayRam07

[masterismail]

hi ! @invinayak007 this issue seems to be idle, Can I work on this ? will be having pretty much the same approach (HLD)

[VedantKhairnar]

Hello @masterismail @prakharsingh-74
Are you open to working on this ticket? If yes, pls raise the PR and do give us an indication that you are working on it.
Thanks.

[masterismail]

Hi @VedantKhairnar , I’m currently occupied with a C4GT project, so I won’t be able to work on this.

[RishiikeshBalaji]

hi @VedantKhairnar can I work on this?

[VedantKhairnar]

Sure @RishiikeshBalaji . Pls directly raise the PR. we will assign it to you once the draft PR is raised. Thanks

[RishiikeshBalaji]

Thanks for the response @VedantKhairnar.
May I know what is the expectation from draft PR?

[RishiikeshBalaji]

@invinayak007 can we connect over discord to further discuss about this?