Skip to content
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

remove types setuptools and release 1.31 #1512

Merged
merged 14 commits into from
Aug 2, 2024
Merged

Conversation

cqc-melf
Copy link
Contributor

@cqc-melf cqc-melf commented Aug 2, 2024

Description

Please summarise the changes.

Related issues

Please mention any github issues addressed by this PR.

Checklist

  • I have performed a self-review of my code.
  • I have commented hard-to-understand parts of my code.
  • I have made corresponding changes to the public API documentation.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have updated the changelog with any user-facing changes.

@cqc-melf
Copy link
Contributor Author

cqc-melf commented Aug 2, 2024

Tries to solve #1513

@cqc-melf cqc-melf marked this pull request as ready for review August 2, 2024 09:55
@cqc-melf cqc-melf changed the title remove types setuptools remove types setuptools and release 1.31 Aug 2, 2024

* remove types-pkg_resources dependency
Copy link
Contributor

Choose a reason for hiding this comment

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

GIven that the removal of this package from pypi renders pytket uninstallable I think we should announce this more prominently in the docs. What do you think?

Copy link
Contributor

Choose a reason for hiding this comment

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

I can do this in a separate PR

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes we should do that. Feel free to make a second PR for that.

@sjdilkes
Copy link
Contributor

sjdilkes commented Aug 2, 2024

Looks like we might be in luck here - have you also tried installing in a fresh local environment where we can be sure there's no lingering installation of types-pkg_resources? I assume the CI is set up to do this, but a sanity check would be helful.

pytket/docs/changelog.rst Outdated Show resolved Hide resolved
Co-authored-by: Silas Dilkes <36165522+sjdilkes@users.noreply.github.com>
@jake-arkinstall
Copy link
Contributor

A couple of thoughts of potential relevance:

  • The version and release strings in pytket/docs/conf.py (I read the version from there when providing nix with the version information) still reference "1.30" - if this PR is for bumping the version should those be changed as part of it?
  • poetry.lock still mentions pkg-resources

@cqc-melf
Copy link
Contributor Author

cqc-melf commented Aug 2, 2024

Looks like we might be in luck here - have you also tried installing in a fresh local environment where we can be sure there's no lingering installation of types-pkg_resources? I assume the CI is set up to do this, but a sanity check would be helful.

Yes I did that:

  • install pytket
  • run python tests
  • run mypy checks
  • make sure types-pkg-resources is still not installed

@cqc-melf
Copy link
Contributor Author

cqc-melf commented Aug 2, 2024

The doc test run currently in an older version and I don't see and easy way to solve that at the moment. I would suggest removing the doc checks for now and try to add them back in later.

The main problem is:
Docs need poetry
Poetry does not like setup.py
(I think the solution should be building a wheel first and loading that device specific into poetry is a to complicated change for a release PR, and not fully sure that would work)

@cqc-melf
Copy link
Contributor Author

cqc-melf commented Aug 2, 2024

@sjdilkes @CalMacCQ should be ready for review now. If there are any questions or anything we should discuss, happy to have a call.

Copy link
Contributor

@CalMacCQ CalMacCQ left a comment

Choose a reason for hiding this comment

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

Looks good to me.

The TKET webiste will pick up the v1.31 from pypi once the release is put out and will build the docs.

After the 1.31 release is out we can re-enable the test of the docs build

@cqc-melf cqc-melf merged commit 9d620f1 into main Aug 2, 2024
32 checks passed
@cqc-melf cqc-melf deleted the melf/fix-types-setuptools branch August 2, 2024 12:39
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.

4 participants