search

Data-Simply / pyretailscience

pyretailscience - A data analysis and science toolkit for detail data
Other
5 stars 1 forks source link

chore: removed un-needed dependencies #59

Closed mvanwyk closed 4 months ago

mvanwyk commented 4 months ago

PR Type

enhancement, dependencies

Description

Changes walkthrough 📝

Relevant files
Dependencies
pyproject.toml
Remove unneeded dependencies from pyproject.toml                 
pyproject.toml
  • Removed seaborn and strictyaml dependencies.
  • Cleaned up unnecessary blank lines.
    		•  +0/-4     

    💡 PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    Summary by CodeRabbit

    coderabbitai[bot] commented 4 months ago

    Walkthrough

    The changes involve removing seaborn and strictyaml dependencies from pyproject.toml and updating the versions of several other dependencies. The updated dependencies include pandas, pyarrow, matplotlib, numpy, loguru, tqdm, great-expectations, nbstripout, ruff, pre-commit, jupyterlab, mkdocs-material, and mkdocstrings. These modifications aim to streamline the project's dependencies and ensure compatibility with newer versions.

    Changes

    File Change Summary
    pyproject.toml Removed seaborn = "^0.13.1" and strictyaml = "^1.7.3". Updated versions for multiple dependencies.

    Poem

    In the code's garden, dependencies pruned,
    Seaborn and strictyaml, their exits attuned.
    Updates aplenty, new versions in flight,
    Enhancing the project, all dependencies light.
    Amid data and plots, a cleaner path drawn,
    With each update made, a brighter new dawn. 🌸

    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 Configration 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.
    codiumai-pr-agent-pro[bot] commented 4 months ago

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    codiumai-pr-agent-pro[bot] commented 4 months ago

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Maintainability
    Avoid duplicating dependencies across different groups for simpler management ___ **Review the necessity of duplicating the tqdm dependency in multiple groups (examples
    and root dependencies). If the same version is used across different groups,
    consider maintaining it only at the root level to simplify dependency management.** [pyproject.toml [16-31]](https://github.com/Data-Simply/pyretailscience/pull/59/files#diff-50c86b7ed8ac2cf95bd48334961bf0530cdc77b5a56f852c5c61b89d735fd711R16-R31) ```diff -tqdm = "^4.66.1" +# If applicable, maintain only at the root level: +# tqdm = "^4.66.1" ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 9 Why: Reviewing the necessity of duplicating the `tqdm` dependency can simplify dependency management and reduce potential conflicts. This suggestion is highly relevant for maintainability.
    		9
    Possible issue
    Verify dependencies before removing packages to avoid breaking the project ___ **Ensure that the removal of seaborn and strictyaml does not affect any existing
    functionality or dependencies in your project. It's important to verify that no code
    or other dependencies rely on these packages before removing them.** [pyproject.toml [12-14]](https://github.com/Data-Simply/pyretailscience/pull/59/files#diff-50c86b7ed8ac2cf95bd48334961bf0530cdc77b5a56f852c5c61b89d735fd711R12-R14) ```diff -seaborn = "^0.13.1" -strictyaml = "^1.7.3" +# Ensure no dependency issues before removing: +# seaborn = "^0.13.1" +# strictyaml = "^1.7.3" ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 8 Why: Ensuring that the removal of `seaborn` and `strictyaml` does not affect existing functionality is crucial. Commenting out the lines instead of removing them outright is a good practice to prevent potential issues.
    		8
    Best practice
    Pin numpy version to a specific minor version for better stability ___ **Consider pinning the version of numpy to a more specific minor version rather than
    the major version to ensure compatibility and predictability in builds. Using
    "^1.26.3" allows any version up to but not including 2.0.0, which might introduce
    breaking changes.** [pyproject.toml [14]](https://github.com/Data-Simply/pyretailscience/pull/59/files#diff-50c86b7ed8ac2cf95bd48334961bf0530cdc77b5a56f852c5c61b89d735fd711R14-R14) ```diff -numpy = "^1.26.3" +numpy = "^1.26.x" ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 7 Why: Pinning the version of `numpy` to a specific minor version can help ensure compatibility and predictability in builds. However, the suggested version "^1.26.x" is not valid TOML syntax. The suggestion is correct in principle but needs a valid version format.
    		7
    Add a specific minor version constraint to loguru for increased stability ___ **Consider adding a version constraint to loguru to prevent potential compatibility
    issues with future releases that might introduce breaking changes.** [pyproject.toml [15]](https://github.com/Data-Simply/pyretailscience/pull/59/files#diff-50c86b7ed8ac2cf95bd48334961bf0530cdc77b5a56f852c5c61b89d735fd711R15-R15) ```diff -loguru = "^0.7.2" +loguru = "^0.7.x" ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 7 Why: Adding a specific minor version constraint to `loguru` can help prevent compatibility issues with future releases. However, the suggested version "^0.7.x" is not valid TOML syntax. The suggestion is correct in principle but needs a valid version format.
    		7