Skip to content

feat: rename package from sepal_ui to pysepal (Phase 2)#975

Merged
dfguerrerom merged 18 commits intomainfrom
feat/phase2-rename-b1
Mar 4, 2026
Merged

feat: rename package from sepal_ui to pysepal (Phase 2)#975
dfguerrerom merged 18 commits intomainfrom
feat/phase2-rename-b1

Conversation

@dfguerrerom
Copy link
Collaborator

@dfguerrerom dfguerrerom commented Mar 3, 2026

Summary

  • Renames the source directory sepal_ui/pysepal/ and updates all internal imports, tests, docs, templates, and notebooks
  • Adds a backward-compatibility shim at sepal_ui/__init__.py that redirects all sepal_ui.* imports to pysepal.* with a DeprecationWarning
  • Updates pyproject.toml distribution name from sepal-ui to pysepal (entry points, coverage, codespell, commitizen)
  • Adds dual-read logic in module_deploy and template noxfiles to accept both [pysepal] and [sepal-ui] config sections
  • Keeps ~/.sepal-ui-config, sepalui logger namespace, and sepal-ui-script CSS class unchanged for backward compatibility

What is NOT renamed (deferred)

Item Reason
~/.sepal-ui-config file path Would break user settings
[sepal-ui] ConfigParser section Dual-read added instead
sepalui logger namespace Would break downstream logging config
sepal-ui-script CSS class DOM-level, no benefit
GitHub repo URL/org Phase 3

Test plan

  • import pysepal works for all entry paths
  • import sepal_ui still works via shim with deprecation warning
  • from sepal_ui.sepalwidgets import AppBar redirects correctly
  • Full test suite passes (273/273, 7 skipped)
  • module_deploy dual-read accepts both [pysepal] and [sepal-ui]
  • CI passes
  • Docs build on RTD

References

Design for the mechanical rename from sepal_ui to pysepal,
covering scope, compatibility shim, PR breakdown, and validation.
Detailed task-by-task plan for renaming sepal_ui to pysepal across
three PRs: directory rename + shim, import rename, and docs/templates.
- pyproject.toml: name, entry points, packages, coverage, codespell, commitizen
- noxfile.py: sphinx-apidoc and mypy paths
- .readthedocs.yaml: sphinx-apidoc path
- unit.yml: template notebook test paths
@codecov-commenter
Copy link

codecov-commenter commented Mar 3, 2026

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

❌ Patch coverage is 91.71975% with 13 lines in your changes missing coverage. Please review.
✅ Project coverage is 79.97%. Comparing base (bc7e872) to head (92066dd).

Files with missing lines Patch % Lines
pysepal/sepalwidgets/file_input.py 0.00% 3 Missing ⚠️
pysepal/solara/session_manager.py 0.00% 3 Missing ⚠️
pysepal/solara/utils.py 0.00% 3 Missing ⚠️
pysepal/scripts/gee.py 66.66% 1 Missing ⚠️
pysepal/scripts/sepal_client.py 0.00% 1 Missing ⚠️
pysepal/scripts/thread_controller.py 0.00% 1 Missing ⚠️
pysepal/solara/decorators.py 0.00% 1 Missing ⚠️
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #975      +/-   ##
==========================================
- Coverage   80.00%   79.97%   -0.03%     
==========================================
  Files          56       56              
  Lines        5546     5544       -2     
==========================================
- Hits         4437     4434       -3     
- Misses       1109     1110       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@dfguerrerom dfguerrerom merged commit 2bfed84 into main Mar 4, 2026
8 checks passed
@dfguerrerom dfguerrerom deleted the feat/phase2-rename-b1 branch March 4, 2026 09:18
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.

2 participants