just setting up the new INSIGHTS microservice

[Baalmart]

WHAT DOES THIS PR DO?

• [ ] just setting up the new INSIGHTS microservice which is a clone of ANALYTICS microservice. This will be used for heavy refactoring of the Analytics microservice and will eventually substitute the Analytics microservice in the long run.

Summary by CodeRabbit

• New Features

  • Introduced .dockerignore and .gitignore files to optimize Docker builds and maintain a cleaner repository.
  • Added a Dockerfile for multi-stage builds of a Python-based application.
  • Created a Jenkinsfile to define a CI/CD pipeline for automated builds and deployments.
  • Added comprehensive API documentation for multiple new endpoints related to air quality data and reporting.
  • Introduced utility functions for string format conversions and data formatting for air quality metrics.

• Bug Fixes

  • None reported.

• Documentation

  • Added a README.md file with setup instructions for the insights microservice.

• Tests

  • Introduced unit tests for air quality data formatting and mock data fixtures to enhance testing capabilities.

• Chores

  • Organized and modularized API models for better maintainability.

[coderabbitai[bot]]

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

## Walkthrough This update introduces significant enhancements to the AirQo Insights API, including the addition of new API endpoints, middleware, and models to handle air quality data effectively. Improvements also include structured documentation for better usability, optimized Docker configurations for a streamlined build process, and robust testing utilities to ensure software reliability. Overall, these changes foster a more organized and efficient development environment, paving the way for enhanced air quality monitoring capabilities. ## Changes | Files | Change Summary | |------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `src/insights/.dockerignore`, `src/insights/.gitignore`, `src/insights/Dockerfile`, `src/insights/Jenkinsfile`, `src/insights/README.md` | Newly created files for ignoring specific files in Docker and Git, a Dockerfile for multi-stage builds, a Jenkinsfile for CI/CD processes, and a README for setup instructions. | | `src/insights/api/docs/dashboard/*.yml` | Multiple new YAML files define various API endpoints for dashboard functionalities, including fetching customized chart data, monitoring site data, and exceedances based on air quality metrics. | | `src/insights/api/middlewares/__init__.py`, `src/insights/api/middlewares/base_validator.py` | New middleware components for organizing routes and custom error handling in the Flask application. | | `src/insights/api/models/*.py` | Introduction of new models (e.g., `Collection`, `SiteModel`, `EventsModel`, `ExceedanceModel`) to manage data interactions with MongoDB, incorporating functionalities for data exporting and querying. | | `src/insights/api/tests/conftest.py`, `src/insights/api/tests/test_data_formatters.py` | New test utilities and unit tests to validate the functionality of data processing and formatting functions, improving overall test coverage. | | `src/insights/api/utils/*.py` | New utility functions for string formatting, date conversions, and data processing to enhance air quality data management capabilities. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant User participant API participant DB User->>API: Request air quality data API->>DB: Query for air quality records DB-->>API: Return queried data API-->>User: Send formatted air quality data ``` ```mermaid sequenceDiagram participant User participant API participant GCS User->>API: Request data export API->>GCS: Initiate export process GCS-->>API: Confirm export start API-->>User: Notify export completion ``` ## Poem > In the realm of air and light, > New paths we tread, a wondrous sight. > With models strong and endpoints bright, > We grasp the data, take flight! > In every breath, a clearer fight, > Together we soar, through day and night! 🌍✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.