-
Notifications
You must be signed in to change notification settings - Fork 12
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
Use pypyoject toml #56
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for doing this! I've left one minor comment and a question for clarification.
tox.ini
Outdated
envlist = py38, py39, py310, py311 | ||
# isolated_build = True | ||
|
||
[testenv] | ||
deps = | ||
-r {toxinidir}/requirements_dev.txt | ||
readme_renderer |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is this doing?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for calling this out. This package is intended to check if the README.rst
can be rendered on PyPi. The inclusion of this package was inspired by sampleproject
's use in tox.ini
.
Given the current state of the package's PyPi page I removed it from the dependency list. With that being said we can add it later if we decide to enhance our CI processes or use automated publishing.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Interesting, thanks.
Summary
This PR responds to issue #49 and migrates
setup.py
configurations topyproject.toml
.Issues Addressed
Changes Made
To modernize the structure of this package I largely followed the example by PyPa's
sampleproject
repository.build
to build the package withinMakefile
.setup.py
and migrate settings topyproject.toml
version
hyper parameter fromargparse_dataclass.py
to theproject.version
field ofpyproject.toml
build
to dependencies withinrequirements_dev.txt
andpyproject.toml
[project.optional-dependencies]
field withinpyproject.toml
. This inclusion enables the following behavior:readme_renderer
totox.ini
as persampleproject
'stox.ini
.version
from2.0.1
to2.1
CHANGELOG.md
to track changesConsiderations
twine
to validate the distributions prior to publishing. We can add the following script tobuild
and within the workflow:twine check dist/*
This change must be accompanied with the addition of
twine
in thedev
requirements. See python documentation andsampleproject
'stox.ini
.readme_renderer
seems to be insurance for issues that may arise in deployment.2.0.0
->2.0.1
->2.1.0
presents a potential headache as2.0.1
is still unreleased. We can combine the unreleased changes from2.0.1
into2.1.0
-- what do you think?Sources
sampleproject
packagebuild
package