hbmartin / graphviz2drawio

Convert graphviz (dot) files to draw.io / lucid (mxGraph) format. Beautiful and editable graphs in your favorite editor.
https://pypi.org/project/graphviz2drawio/
GNU General Public License v3.0
186 stars 32 forks source link

Maintenance and release prep for 1.0 #92

Closed hbmartin closed 1 month ago

hbmartin commented 1 month ago

Summary by Sourcery

Prepare for the 1.0 release by updating the project version, enhancing the project description, and adjusting the development status to stable. Remove outdated test cases and update documentation badges.

Enhancements:

Documentation:

Chores:

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

[!WARNING]

Rate limit exceeded

@hbmartin has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 9 minutes and 53 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between ee36d2e0e84422086bec252478bb77b329d6f661 and 5af828e1de8d94c5393eba5e002c5aa82a7290b6.

Walkthrough

This update enhances the graphviz2drawio project by improving documentation and usability metrics. Key changes include a version bump to 1.0.0, the addition of a Maintainability Rating badge, and a refined project description emphasizing the quality of output graphs. Development status has been upgraded to indicate production readiness, and some outdated tests were commented out, streamlining the testing process.

Changes

Files Change Summary
README.md, setup.py Updated project description for clarity and marketing appeal. Removed Twitter badge; added Maintainability Rating badge from SonarCloud.
graphviz2drawio/version.py Changed version from "0.5.0" to "1.0.0", indicating a major update.
setup.py Updated development status to "Production/Stable" and added Python 3.13 compatibility classifier.
test/test_graphs.py Commented out specific test functions (test_aws_diagram_with_images, test_runAll), simplifying the test suite while retaining the functionality of remaining tests.
.github/workflows/*.yml Added permissions sections for CI workflows to enhance security and access control during execution.
graphviz2drawio/mx/Styles.py Refactored string declarations in the Styles Enum class for improved readability and maintainability.
pyproject.toml Removed linting rules associated with Styles.py, indicating a potential cleanup of the project's linting configuration.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Graphviz2Drawio
    participant Editor

    User->>Graphviz2Drawio: Convert graphviz dot file
    Graphviz2Drawio->>Editor: Output draw.io / lucid format
    Editor->>User: Displays beautiful and editable graph

🐰 "Hippity hop, with version new,
Our graphs are bright, and edits too!
A badge of care, we now display,
For maintainability, hip-hip hooray!
With tests refined, we leap with glee,
Join us now, come graph with me!" 🌼


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.
sourcery-ai[bot] commented 1 month ago

Reviewer's Guide by Sourcery

This pull request prepares the project for a 1.0 release by making several maintenance updates. The changes include updating version numbers, improving project metadata, cleaning up test files, and making minor code style improvements. The PR doesn't introduce any new features or major changes to the core functionality.

File-Level Changes

Files Changes
graphviz2drawio/version.py Updated the project version from 0.5.0 to 1.0.0, signifying a major release.
test/test_graphs.py Removed commented-out test functions and an unused test case in the test file.
setup.py Updated setup.py with a more detailed project description, added Python 3.13 to supported versions, and changed the development status to 'Production/Stable'.
README.md Updated README.md with a new project description and replaced the Twitter badge with a SonarCloud Maintainability Rating badge.
setup.py Made minor code style improvements, such as reordering imports in setup.py.

Tips - Trigger a new Sourcery review by commenting `@sourcery-ai review` on the pull request. - Continue your discussion with Sourcery by replying directly to review comments. - You can change your review settings at any time by accessing your [dashboard](https://app.sourcery.ai): - Enable or disable the Sourcery-generated pull request summary or reviewer's guide; - Change the review language; - You can always [contact us](mailto:support@sourcery.ai) if you have any questions or feedback.
sonarcloud[bot] commented 1 month ago

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud