Skip to content

Conversation

@brandonHaipas
Copy link
Contributor

@brandonHaipas brandonHaipas commented Apr 23, 2025

Description

Issue #99 fix. There are still tests to pass.

Fixes # (issue)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)

Testing

I used all the tests provided by the repo using tox, first with a specific python version (3.11) and then with versions 3.8 to 3.11.

  • Tested using tox. For tox to work on your machine you have to install all python versions specified in tox.ini either with pyenv in linux or other environment manager of your preference.

Since the Harmony Python package is used by the Harmony API (which is itself used by the R library and the web app), we need to avoid making any changes that break the Harmony API. Please also run the Harmony API unit tests and check that the API still runs with your changes to the Python package: https://github.com/harmonydata/harmonyapi

Test Configuration

  • Library version: 1.0.5
  • OS: Xubuntu 24.04
  • Toolchain: tox

Checklist

  • My PR is for one issue, rather than for multiple unrelated fixes.
  • My code follows the style guidelines of this project. I have applied a Linter (recommended: Pycharm's code formatter) to make my whitespace consistent with the rest of the project.
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings
  • The Harmony API is not broken by my change to the Harmony Python library
  • I add third party dependencies only when necessary. If I changed the requirements, it changes in requirements.txt, pyproject.toml and also in the requirements.txt in the API repo
  • If I introduced a new feature, I documented it (e.g. making a script example in the script examples repository so that people will know how to use it.

Optionally: feel free to paste your Discord username in this format: discordapp.com/users/yourID in your pull request description, then we can know to tag you in the Harmony Discord server when we announce the PR.

@brandonHaipas
Copy link
Contributor Author

This is a work in progress — I haven't tested the harmonydata API yet.

…supported go from 3.9 to 3.13.3, and across all python versions supported the package fails only 1 test from 68
@woodthom2
Copy link
Contributor

Thanks Brandon - is it still a work in progress?

@brandonHaipas
Copy link
Contributor Author

I couldn't test the Harmony API because it has problems too; I'd have to fork it and correct the same issues. However, I managed to make it work for versions 3.9 to 3.13 with the same error I reported. I haven't had time to fix the API import errors yet, but some of them should be fixed by changing the package versions in the requirements.txt file to those used here.

@woodthom2
Copy link
Contributor

Thanks for the clarification @brandonHaipas . I have made a corresponding issue in the API repo here: harmonydata/harmonyapi#22 - so when someone has time they can pick that up and bring the API in line with your fork. Great work!

@jaydugad jaydugad merged commit a82ec7b into harmonydata:main May 8, 2025
1 check failed
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