PR3: Display changelog/announcement page in SLEAP GUI

shrivaths16 commented 1 year ago

Description

Creating a new file bulletin.py and class BulletinDialog to display the announcement. An instance of this BulletinDialog class is created while initializing the MainWindow if there is an unseen announcement.

This will create a bulletin pop-up that will display the latest information that is found in the bulletin.md file.

Types of changes

[ ] Bugfix
[ ] New feature
[ ] Refactor / Code style update (no logical changes)
[ ] Build / CI changes
[ ] Documentation Update
[ ] Other (explain)

Does this address any currently open issues?

1563

Outside contributors checklist

[ ] Review the guidelines for contributing to this repository
[ ] Read and sign the CLA and add yourself to the authors list
[ ] Make sure you are making a pull request against the develop branch (not main). Also you should start your branch off develop
[ ] Add tests that prove your fix is effective or that your feature works
[ ] Add necessary documentation (if appropriate)

Thank you for contributing to SLEAP!

:heart:

Summary by CodeRabbit

New Features
- Implemented a bulletin dialog to display new announcements to users.
Tests
- Introduced checks for bulletin display in GUI tests.
Chores
- Adjusted styling for markdown content display.

codecov[bot] commented 1 year ago

Codecov Report

Attention: 7 lines in your changes are missing coverage. Please review.

Comparison is base (c218b10) 73.39% compared to head (150453d) 73.46%.

Files	Patch %	Lines
sleap/gui/app.py	85.71%	3 Missing :warning:
sleap/gui/commands.py	66.66%	2 Missing :warning:
sleap/gui/dialogs/bulletin.py	95.55%	2 Missing :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## shrivaths/changelog-announcement-2 #1556 +/- ## ====================================================================== + Coverage 73.39% 73.46% +0.06% ====================================================================== Files 134 135 +1 Lines 24069 24139 +70 ====================================================================== + Hits 17666 17734 +68 - Misses 6403 6405 +2 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

coderabbitai[bot] commented 1 year ago

CodeRabbit review skipped

By default, CodeRabbit only reviews PRs on the default branch. If you wish to have PRs reviewed on additional branches, you can configure that under the repository settings in the UI.

coderabbitai[bot] commented 1 year ago

Walkthrough

The SLEAP GUI has introduced a new feature to keep users informed of updates through a bulletin dialog. This feature includes the creation of a BulletinDialog class, a BulletinWorker to fetch and display announcements, and a system to track when users last saw an announcement. Additionally, changes to the GUI styling and updates to AUTHORS files reflect contributions and code maintenance efforts.

Changes

File Path	Change Summary
`sleap/gui/app.py`	Reorganized initialization logic, added `bulletin_dialog` method, and included new imports.
`sleap/gui/dialogs/bulletin.py`	Introduced `BulletinDialog` and related entities for displaying announcements in the GUI.
`sleap/gui/commands.py`	Added a new method `showBulletin` to the `Commands` class and a corresponding `ShowBulletin` class with a `do_action` method to open the latest bulletin.
`tests/gui/test_app.py`	Added a check for a bulletin in the `test_app_workflow` function.

Related issues

talmolab/sleap#1563: The changes in this PR seem to address the request for a changelog/announcements feature in the SLEAP GUI, as evidenced by the addition of BulletinDialog and BulletinWorker, which could display updates and announcements to the user.

Poem

🐰 Oh hop and leap, let's take a peek,
📜 A bulletin's here, with updates each week.
🌟 No need to search, it's all in view,
🎉 SLEAP's new feature, fresh as morning dew.

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: - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit-tests for this file.` - 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 tests 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 from git and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit tests.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` 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 a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - 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/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.

talmolab / sleap