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

[WIP] Use Poetry as the dependency manager of this library #3257

Draft
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

bitterteriyaki
Copy link

@bitterteriyaki bitterteriyaki commented May 29, 2024

Pull Request check-list

  • Do tests and lints pass with this change?
  • Do the CI tests pass with this change (enable it first in your forked repo and wait for the github action build to finish)?
  • Is the new or changed code fully tested?
  • Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?
  • Is there an example added to the examples folder (if applicable)?
  • Was the change added to CHANGES file?

Description of change

Use Poetry as the package manager of this library.

Checklist

  • Migrate all the fields from setup.py to pyproject.toml
  • Update CI workflows
  • Maybe put all configuration files from another libraries (e.g. .flake8, .isort.cfg, etc.) into pyproject.toml?
  • Update CONTRIBUTING.md file
  • Update documentation and README.md

@bitterteriyaki
Copy link
Author

bitterteriyaki commented May 29, 2024

Is this a good time to upgrade the outdated dependencies (including dev deps)?

@bitterteriyaki bitterteriyaki changed the title [WIP] Add Poetry as dependency manager [WIP] Use Poetry as the default dependency manager of this library May 29, 2024
@bitterteriyaki bitterteriyaki changed the title [WIP] Use Poetry as the default dependency manager of this library [WIP] Use Poetry as the dependency manager of this library May 29, 2024
@bitterteriyaki
Copy link
Author

bitterteriyaki commented May 29, 2024

I took a little liberty to add some improvements to the workflow. If you don't like it or want any changes, don't hesitate to leave feedback. 😄

  • I changed the job name and added names to all steps
  • I changed the workflow name
  • I moved the permissions object to its respective job

I did not tested this workflow yet, it can be broken.

@bitterteriyaki
Copy link
Author

I'm getting some conflicts from the docs/requirements.txt dependencies. The ipython library needs Python 3.10+ but this project has support to Python 3.8. I'll wait any maintainer to answer how to proceed in this situation.

@akx
Copy link
Contributor

akx commented Jun 12, 2024

I wouldn't use Poetry for library packaging – it might be OK for applications, but I don't think it's the best fit for libraries.

Please also see #1658 for previous discussion.

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