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

[FEATURE] Migrate to pyproject.toml #308

Open
rawwar opened this issue Oct 6, 2023 · 8 comments
Open

[FEATURE] Migrate to pyproject.toml #308

rawwar opened this issue Oct 6, 2023 · 8 comments
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@rawwar
Copy link
Contributor

rawwar commented Oct 6, 2023

Current opensearch-py-ml project uses setup.py and setup.cfg to maintain project metadata. pyproject.toml is the new standard. PEP 621, which was accepted in 2021, designated pyproject.toml as the standard way to specify project metadata for Python packages. setuptools and other packaging tools now support pyproject.toml, and it is expected to become the de facto standard for Python packaging in the future.

pyproject.toml also supports few features that are not available in setup.cfg, such as dynamic metadata and optional dependencies.

Edit-1: Added more information on why to migrate.

@rawwar rawwar added enhancement New feature or request untriaged labels Oct 6, 2023
@rawwar
Copy link
Contributor Author

rawwar commented Oct 6, 2023

@dhrubo-os , I am willing to raise a PR for this.

@dhrubo-os
Copy link
Collaborator

@rawwar Thank you for creating the issue. I would like you to expand this issue description a bit more, such as explaining why we should adopt pyproject.toml and what advantages we will gain over the current process, etc.

@dhrubo-os dhrubo-os added good first issue Good for newcomers and removed untriaged labels Oct 10, 2023
@rawwar
Copy link
Contributor Author

rawwar commented Oct 11, 2023

@dhrubo-os , Would you consider this as a major change? I am wondering if we should be doing this migration as part of next major release?

@bilal-aamer
Copy link

Hey @rawwar @dhrubo-os, would love to contribute to this migration to pyproject.toml

@rawwar
Copy link
Contributor Author

rawwar commented Nov 30, 2023

@bilal-aamer , that would be great. Please feel free to raise a PR. I would be happy to help and review.

@dhrubo-os , do you think there are any pre-requisites before @bilal-aamer works on it?

@dhrubo-os
Copy link
Collaborator

I don't think so. @bilal-aamer thanks for looking into this. Assigned this to you.

@rawwar
Copy link
Contributor Author

rawwar commented Dec 13, 2023

@bilal-aamer , how is it going? If you need any help, please raise a draft PR with whatever you have done so far and I can try to help.

@bilal-aamer
Copy link

Hey @rawwar, will do right away been looking into pyproject.toml.

Will get a generic PR out right away.

This was referenced Dec 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants