Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Register s3 backend #456

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Register s3 backend #456

wants to merge 1 commit into from

Conversation

hagenw
Copy link
Member

@hagenw hagenw commented Nov 8, 2024

Closes #455

To make it easier for the user to setup a S3 storage, I registered it as an backend as well (using the same backend as minio):

image

When configuring a repository, the user can now write:

audb.Repository("repo", "s3.dualstack.some-region.amazonaws.com", "s3")

instead of having to write

audb.Repository("repo", "s3.dualstack.some-region.amazonaws.com", "minio")

Copy link

sourcery-ai bot commented Nov 8, 2024

Reviewer's Guide by Sourcery

This PR adds S3 as a registered backend alias for the existing Minio backend implementation, simplifying the configuration process for users working with S3 storage. The change is implemented by adding a new entry to the backend registry dictionary that maps 's3' to the same Minio backend class.

Updated class diagram for Repository backend registry

classDiagram
    class Repository {
        +Repository(name, host, backend)
        +backends: dict
    }
    class Artifactory
    class FileSystem
    class Minio
    Repository --> Artifactory : "artifactory"
    Repository --> FileSystem : "file-system"
    Repository --> Minio : "minio"
    Repository --> Minio : "s3"
Loading

File-Level Changes

Change Details Files
Added S3 as an alias for the Minio backend in the backend registry
  • Added 's3' key to the backend registry dictionary pointing to audbackend.backend.Minio
  • Updated documentation to remove specific mention of using 'minio' backend for S3 storage
audb/core/repository.py

Assessment against linked issues

Issue Objective Addressed Explanation
#455 Add 's3' as an alias in the backend registry that points to the Minio backend
#455 Update documentation to remove the note about using 'minio' backend for S3 storage

Possibly linked issues


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

@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 adding a note in the docstring that 's3' and 'minio' backends are equivalent to help users understand the relationship between these options.
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.

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.

Add s3 to registered backends
1 participant