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

Release/v0.1 rc4 #26

Merged
merged 19 commits into from
Jan 30, 2025
Merged

Release/v0.1 rc4 #26

merged 19 commits into from
Jan 30, 2025

Conversation

wvenialbo
Copy link
Owner

@wvenialbo wvenialbo commented Jan 30, 2025

Summary by Sourcery

Rename the package from GOES-DL to goesdl. Update the documentation and examples to reflect the new package name. Update the fourth-generation GOES satellites name from GOES 3rd Generation to GOES 4th Generation.

Build:

  • Update the package name in the build system.

CI:

  • Update the CI workflows to use the new package name.

Documentation:

  • Update the README file with the new package name and usage examples. Add a new examples directory with Jupyter notebooks demonstrating how to use the package.

Tests:

  • Update the test suite to use the new package name.

The package directory is renamed from `GOES_DL` to `goesdl` to
be compliant with the Python package naming convention.
Copy link

sourcery-ai bot commented Jan 30, 2025

Reviewer's Guide by Sourcery

This pull request focuses on refactoring the project by renaming the root package from 'GOES_DL' to 'goesdl'. This change impacts the import statements, the package definition, and the test suite. Additionally, the documentation was updated to reflect the change, and a new example notebook was added.

Class diagram showing updated import paths

classDiagram
    class goesdl {
        +__version__: str
        +__package_id__: str
        +__package_name__: str
    }

    class dataset {
        +GridSatProductLocatorB1
        +GridSatProductLocatorGC
        +GOESProductLocatorABIPP
    }

    class datasource {
        +DatasourceAWS
        +DatasourceHTTP
        +DatasourceCache
    }

    class downloader {
        +Downloader
        +download_files()
        +list_files()
        +get_files()
    }

    goesdl --> dataset
    goesdl --> datasource
    goesdl --> downloader

    note for goesdl "Package renamed from GOES_DL to goesdl"
Loading

File-Level Changes

Change Details Files
Renamed the root package from 'GOES_DL' to 'goesdl'.
  • Updated import statements to reflect the new package name.
  • Modified the package definition in pyproject.toml.
  • Adjusted test suite imports to use the new package name.
  • Updated documentation to reflect the new package name.
README.md
.github/workflows/python-lint.yml
pyproject.toml
test.py
src/goesdl/downloader/downloader.py
.github/workflows/python-autopep.yml
.github/workflows/python-bandit.yml
.github/workflows/python-black.yml
.github/workflows/python-docsig.yml
.github/workflows/python-flake.yml
.github/workflows/python-isort.yml
.github/workflows/python-mypy.yml
.github/workflows/python-pycodestyle.yml
.github/workflows/python-pydoclint.yml
.github/workflows/python-pydocstyle.yml
.github/workflows/python-pyflakes.yml
.github/workflows/python-pylint.yml
.github/workflows/python-ruff.yml
scripts/toolchain.ps1
src/goesdl/__init__.py
tests/test_gridsat_locator_b1.py
tests/test_gridsat_product_gc.py
tests/test_utils_url.py
Updated the documentation to reflect the new package name and added a new example notebook.
  • Updated the README.md file to reflect the new package name.
  • Added a new example notebook for GOES-R dataset download in Spanish.
  • Added a new example notebook for GridSat-B1 dataset download in English.
README.md
examples/Download_GOES-R_dataset_es.ipynb
examples/Download_GridSat_B1_dataset_en.ipynb

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. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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

@wvenialbo wvenialbo self-assigned this Jan 30, 2025
@wvenialbo wvenialbo merged commit 37f89d1 into develop Jan 30, 2025
64 of 66 checks passed
Copy link
Contributor

deepsource-io bot commented Jan 30, 2025

Here's the code health analysis summary for commits 54e9f20..29c82bb. View details on DeepSource ↗.

Analysis Summary

AnalyzerStatusSummaryLink
DeepSource Python LogoPython❌ Failure
❗ 28 occurences introduced
🎯 23 occurences resolved
View Check ↗
DeepSource Test coverage LogoTest coverage⚠️ Artifact not reportedTimed out: Artifact was never reportedView Check ↗

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

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 @wvenialbo - I've reviewed your changes and they look great!

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.

@wvenialbo wvenialbo deleted the release/v0.1-rc4 branch January 30, 2025 22:35
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