Skip to content

Conversation

@bmusangu
Copy link
Collaborator

@bmusangu bmusangu commented May 9, 2025

This PR modernizes the BlockInverseGPFA package to prepare it for community use, continuous integration, and publication. It includes major packaging, and documentation updates:

  • Declared all core dependencies and optional extras:
    • [test]: for pytest-based testing
    • [docs]: for Sphinx documentation build
  • Removed requirements.txt (no longer needed).
  • Users can now install the package with:
 pip install .
 pip install .[test]
 pip install .[docs]
 
- Added `.readthedocs.yml` for Read the Docs builds
- Updated `ReadMe.md`

@bmusangu bmusangu requested a review from jdrugo May 9, 2025 22:29
Copy link
Collaborator

@jdrugo jdrugo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes look mostly good.

One issue is with the pyproject.toml license line, which should just specify the license through license = "BSD-3-Clause" rather than as file and text. This should fix the the failing tests.

Once the test run, the PR can be merged.

@bmusangu bmusangu merged commit 620ec73 into main May 10, 2025
2 checks passed
@bmusangu bmusangu deleted the dev_autotest branch May 10, 2025 00:51
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.

3 participants