Skip to content

FIREFLY-1527: Update the package/build configuration and cleanup #62

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

Merged
merged 4 commits into from
Aug 30, 2024

Conversation

jaladh-singhal
Copy link
Member

@jaladh-singhal jaladh-singhal commented Aug 30, 2024

Fixes FIREFLY-1527, fixes #60, fixes #51

  • Fixed version retrieval in code, as suggested by pkg_resources is deprecated #51
  • Replaced setup.py and setup.cfg with pyproject.toml, why?
  • Cleaned up obsolete files like travis.yml (we now have a github action to build the website) and requirements.txt (because we define dependencies in pyproject.toml)
  • Updated docs pipeline to use optional [docs] dependencies
  • Fixed some logical linting errors in source files
  • Updated release documentation as per build config changes

Testing

Checkout this branch locally and then in a fresh local venv or conda env, doing pip install . should install firefly_client. Then run example notebooks - they should work

@jaladh-singhal jaladh-singhal requested a review from robyww August 30, 2024 00:44
@jaladh-singhal jaladh-singhal self-assigned this Aug 30, 2024
@jaladh-singhal jaladh-singhal force-pushed the FIREFLY-1527-update-package-config branch from 0a2e763 to d95a01a Compare August 30, 2024 00:56
@bsipocz
Copy link
Member

bsipocz commented Aug 30, 2024

The notebooks now pass all the tests with OSX, as well as without installing setuptools, so from my end this looks good.

Copy link
Contributor

@robyww robyww left a comment

Choose a reason for hiding this comment

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

firefly_client.py and env.py clean up looks good. Documentation updates look good.

I am glad we are staying up-to-date on packaging.

@jaladh-singhal jaladh-singhal merged commit 94c00c5 into master Aug 30, 2024
@jaladh-singhal jaladh-singhal deleted the FIREFLY-1527-update-package-config branch August 30, 2024 18:11
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.

undeclared dependencies causing downstream CI errors pkg_resources is deprecated
3 participants