Skip to content

Add MinIO support with audbackend>=2.1.0#453

Merged
hagenw merged 5 commits into
mainfrom
minio-minimal
Nov 4, 2024
Merged

Add MinIO support with audbackend>=2.1.0#453
hagenw merged 5 commits into
mainfrom
minio-minimal

Conversation

@hagenw
Copy link
Copy Markdown
Member

@hagenw hagenw commented Oct 31, 2024

Adds support for MinIO and S3 backends by depending on audbackend>=2.1.0.

It does not moves the public repository to S3 as proposed in #450, but stays with Artifactory.

Updated README:

image

The new backend is listed as minio under the registered backends:

image

The docstring of audb.Repository.create_backend_interface() has been updated to reflect that we have more than two backends now:

image

Summary by Sourcery

Integrate MinIO support by updating the backend registry and modifying the docstring to reflect the new backend options. This change depends on audbackend version 2.1.0 or higher.

New Features:

  • Add support for MinIO backend by integrating audbackend>=2.1.0.

Enhancements:

  • Update the backend registry to include MinIO as a registered backend.
  • Modify the docstring of audb.Repository.create_backend_interface() to reflect the addition of more than two backends.

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Oct 31, 2024

Reviewer's Guide by Sourcery

This PR adds MinIO backend support by updating the backend registry and modifying the documentation to be more generic for multiple backend types. The implementation leverages audbackend>=2.1.0 which includes MinIO support, while maintaining the existing Artifactory and file-system backends.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added MinIO backend support to the backend registry
  • Added MinIO backend to the backend_registry dictionary
  • Reordered backend entries alphabetically
audb/core/repository.py
Updated documentation to be backend-agnostic
  • Removed specific backend implementation details from docstring
  • Generalized the interface wrapping description
  • Updated file structure example description to be backend-neutral
audb/core/repository.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @hagenw - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider maintaining specific documentation examples for each backend type (Artifactory, FileSystem, and MinIO) in the docstring rather than using a generic description for non-Artifactory cases. This would make it clearer for users working with different backends.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread pyproject.toml Outdated
@hagenw hagenw merged commit a9b9fa5 into main Nov 4, 2024
@hagenw hagenw deleted the minio-minimal branch November 4, 2024 14:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant