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

Add audmodle-internal S3 repo to defaults #6

Merged
merged 5 commits into from
Dec 11, 2024
Merged

Add audmodle-internal S3 repo to defaults #6

merged 5 commits into from
Dec 11, 2024

Conversation

hagenw
Copy link
Member

@hagenw hagenw commented Dec 11, 2024

Add audmodle-internal repository on S3 to the default repositories as configured in audmodel.config.REPOSITORIES.

It also updates the documentation on authentication accordingly (at the moment, we don't have a public repository):

image

It also updates the Repository to support S3 and MinIO, but different to audb we always use the Maven interface for versioning, to provide a better structure for the _uid folder, which we use a lookup for model IDs.

image

Summary by Sourcery

Add the 'audmodel-internal' S3 repository to the default configuration and update the documentation to reflect changes in authentication requirements.

New Features:

  • Add 'audmodel-internal' S3 repository to the default repositories list in the configuration.

Documentation:

  • Update documentation to include information on authentication for the new 'audmodel-internal' S3 repository.

Copy link

sourcery-ai bot commented Dec 11, 2024

Reviewer's Guide by Sourcery

The PR adds a new S3 repository 'audmodel-internal' to the default repositories configuration and updates the authentication documentation. The implementation involves modifying the default repositories list in the config class and updating the related documentation.

Class diagram for updated config class with new repository

classDiagram
    class config {
        +Repository[] REPOSITORIES
    }

    class Repository {
        +String name
        +String url
        +String type
    }

    config "1" -- "*" Repository : contains

    Repository <|-- audmodel-internal : new

    class audmodel-internal {
        +"audmodel-internal"
        +"s3.dualstack.eu-north-1.amazonaws.com"
        +"s3"
    }
Loading

File-Level Changes

Change Details Files
Added a new S3 repository to the default repositories configuration
  • Added 'audmodel-internal' repository configuration with S3 backend
  • Set repository location to 's3.dualstack.eu-north-1.amazonaws.com'
audmodel/core/config.py
Updated authentication documentation
  • Modified authentication documentation to reflect current repository setup
docs/authentication.rst

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:

  • Please complete the documentation in authentication.rst to include details about required AWS credentials and authentication process for the S3 repository.
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.

@hagenw hagenw merged commit 7d2a6af into main Dec 11, 2024
9 checks passed
@hagenw hagenw deleted the add-s3-repo branch December 11, 2024 09:43
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