Skip to content

Add PEP 561 compliance, __all__ exports, and utility re-exports#15

Merged
VoxleOne merged 3 commits intomainfrom
copilot/copilot-changes
Mar 24, 2026
Merged

Add PEP 561 compliance, __all__ exports, and utility re-exports#15
VoxleOne merged 3 commits intomainfrom
copilot/copilot-changes

Conversation

Copy link
Contributor

Copilot AI commented Mar 24, 2026

  • Analyze current architecture (Stage 1) — 57 passed / 5 skipped, installable, importable
  • Define clean library architecture (Stage 2) — __all__ in all modules
  • Add __all__ to all 8 modules for explicit public API surface
  • Add py.typed marker (PEP 561) for downstream type checking
  • Update utils/__init__.py to re-export all 11 public utility functions
  • Add mypy overrides for third-party stubs (scipy, sklearn, healpy, cupy) in pyproject.toml
  • Update MANIFEST.in to include py.typed in sdist
  • Add [tool.setuptools.package-data] for py.typed in wheel builds
  • Classify non-core directories (Stage 3) — benchmark/demos/examples already excluded from distribution
  • Verify packaging (Stage 6) — python -m build --sdist succeeds, py.typed included
  • Add test_api.py with 11 tests validating __all__ exports, py.typed, and __version__
  • Verify all tests pass: 57 passed, 5 skipped (CUDA/healpy)
  • Code review — addressed 2 comments (replaced magic number with expected set, semver regex for version)
  • Security scan (CodeQL) — 0 alerts found

📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.

Copilot AI and others added 2 commits March 24, 2026 17:46
- Add PEP 561 py.typed marker for downstream type checking
- Add __all__ to all modules (node, traversal, discrete, discrete_iterator)
- Add __all__ to all utility modules (array_backend, quaternion_math, quaternion_utils)
- Expose public utilities via spinstep/utils/__init__.py with re-exports
- Improve type hint: batch_quaternion_angle xp parameter now uses ModuleType
- Update MANIFEST.in to include py.typed in sdist
- Enhanced utils/__init__.py docstring with sub-package overview

Co-authored-by: VoxleOne <119956342+VoxleOne@users.noreply.github.com>
Agent-Logs-Url: https://github.com/VoxleOne/SpinStep/sessions/7a270a04-9727-4a04-b894-590cff277144
Copilot AI changed the title [WIP] Refactor repository structure for improved maintainability Add PEP 561 compliance, __all__ exports, and utility re-exports Mar 24, 2026
Copilot AI requested a review from VoxleOne March 24, 2026 17:50
@VoxleOne VoxleOne closed this Mar 24, 2026
@VoxleOne VoxleOne reopened this Mar 24, 2026
@VoxleOne VoxleOne marked this pull request as ready for review March 24, 2026 18:09
@VoxleOne VoxleOne merged commit d4baac3 into main Mar 24, 2026
8 checks passed
@VoxleOne VoxleOne deleted the copilot/copilot-changes branch March 24, 2026 18:12
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