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

Update pyproject.toml #8

Merged
merged 7 commits into from
Aug 16, 2023
Merged

Update pyproject.toml #8

merged 7 commits into from
Aug 16, 2023

Conversation

ElijahSwiftIBM
Copy link
Collaborator

change setup.cfg and setup.py to pyproject.toml

pyproject.toml can still work with a minimal setup.py for dynamic elements like the pyobject we are building, but the pyproject toml is useful

Update pyproject.toml

💡 Issue Reference

Issue: #3

💻 What does this address?

Standards are shifting from setup.py to pyproject.toml for static attributes

📟 Implementation Details

Most items from the setup.py and setup.cfg are moved to pyproject.toml with the exception of dynamic extensions which are still built as part of setup.py

📋 Is there a test case?

Test case suite does not test build, but code was built from pip install through the repo using ssh and a manually built wheel and functionality is still present.

Either include the path to the test case file, or details on a manual test

change setup.cfg and setup.py to pyproject.toml

pyproject.toml can still work with a minimal setup.py for dynamic elements like the pyobject we are building, but the pyproject toml is useful

Update pyproject.toml

Signed-off-by: Elijah Swift <elijah.swift@ibm.com>
@ElijahSwiftIBM ElijahSwiftIBM changed the base branch from main to dev August 9, 2023 14:25
setup.py Outdated Show resolved Hide resolved
@lcarcaramo
Copy link
Member

Linters, code formatters, and other development dependencies don't appear to pulling configuration from pyproject.toml.

@lcarcaramo
Copy link
Member

It also looks like an update or two might need to be made to CONTRIBUTING.md where references to setup.py should probably be changed to pyproject.toml.

@ElijahSwiftIBM
Copy link
Collaborator Author

It also looks like an update or two might need to be made to CONTRIBUTING.md where references to setup.py should probably be changed to pyproject.toml.

Only identified one reference. Changed to:
* Make any necessary updates to pyproject.toml.

@ElijahSwiftIBM
Copy link
Collaborator Author

Linters, code formatters, and other development dependencies don't appear to pulling configuration from pyproject.toml.

to my knowledge, pylint and isort are getting their config correctly. flake8 does not support pyproject.toml. I have added a .flake8 file containing the following for now. This can be changed to a setup.cfg if preferred.

[flake8]
    ignore = W503,E122,E203
    max-line-length = 99
    per-file-ignores = __init__.py:F401

-add .flake8 file
-move items within main in setup.py
-change CONTRIBUTING.md to reference pyproject.toml

Signed-off-by: Elijah Swift <elijah.swift@ibm.com>
pyproject.toml Outdated Show resolved Hide resolved
-flake8 does not support pyproject.toml, we now configure via .flake8 file, removing references to flake8 in toml file.

Signed-off-by: Elijah Swift <elijah.swift@ibm.com>
pyproject.toml Outdated Show resolved Hide resolved
-Add newlines for consistent formatting
-isort change single quotes to double-quotes in setup.py

Signed-off-by: Elijah Swift <elijah.swift@ibm.com>
pyproject.toml Outdated Show resolved Hide resolved
.flake8 Outdated Show resolved Hide resolved
Signed-off-by: Elijah Swift <elijah.swift@ibm.com>
-Remove empty newlines
-Update docstring
-Remove Extra Link Args

Signed-off-by: Elijah Swift <elijah.swift@ibm.com>
setup.py Outdated Show resolved Hide resolved
setup.py Outdated Show resolved Hide resolved
-Fix docstrings
Signed-off-by: Elijah Swift <elijah.swift@ibm.com>
@lcarcaramo lcarcaramo merged commit 31b6f65 into dev Aug 16, 2023
1 check passed
@lcarcaramo lcarcaramo deleted the pyproject-conversion branch August 16, 2023 17:33
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