skpkg: getting package up to scikit-package CI standards
#340
Conversation
| readme = "README.rst" | ||
| requires-python = ">=3.11, <3.14" | ||
| classifiers = [ | ||
| 'Development Status :: 5 - Production/Stable', | ||
| 'Environment :: Console', | ||
| 'Intended Audience :: Developers', | ||
| 'Intended Audience :: Science/Research', | ||
| 'License :: Free To Use But Restricted', | ||
| 'License :: OSI Approved :: BSD License', |
There was a problem hiding this comment.
please check the license to make sure it is BSD before accepting this change.
There was a problem hiding this comment.
@sbillinge confirmed BSD from skpkg
There was a problem hiding this comment.
The relevant license is the diffpy.utils license not the skpkg license. What is the current diffpy.utils license.
| @@ -16,14 +12,3 @@ | |||
| # See LICENSE.rst for license information. | |||
| # | |||
| ############################################################################## | |||
| """diffpy - tools for structure analysis by diffraction. | |||
There was a problem hiding this comment.
its unlikely that we want to delete the contents of this file. But I am not sure. Is this a new development that we can handle the namespace strcture (diffpy.something) without this extend path? We may want to ask @bobleesj
There was a problem hiding this comment.
An empty src/<namespacename>/__init__.py is still needed.
The namespace's``init.py, it's written in post_gen_hook.py` shown below:
def __gen_init__(module_name):
"""Generate __init__.py file for namespace module."""
__init__ = f"""#!/usr/bin/env python
##############################################################################
#
# (c) {% now 'utc', '%Y' %} The Trustees of Columbia University in the City of New York.
# All rights reserved.
#
# File coded by: Billinge Group members and community contributors.
#
# See GitHub contributions for a more detailed list of contributors.
# https://github.com/{{ cookiecutter.github_username_or_orgname }}/{{ cookiecutter.github_repo_name }}/graphs/contributors
#
# See LICENSE.rst for license information.
#
##############################################################################
""" # noqa: E999
return __init__
| yield home_dir, cwd_dir | ||
|
|
||
|
|
||
| @pytest.fixture |
There was a problem hiding this comment.
do you want to delete all our tests?
| @@ -1,6 +1,6 @@ | |||
| """Unit tests for __version__.py.""" | |||
|
|
|||
| import diffpy.utils | |||
| import diffpy.utils # noqa | |||
There was a problem hiding this comment.
It is probably ok to leave these # noqa's but they are not needed. I think we need them in the template because there is jinja code there that black can;t handle but after the template is built it would be better if they were deleted (but not hte end of theworld if they stay.
There was a problem hiding this comment.
@sbillinge I'll investigate to see if there is a way to remove this. There might be a shell script we can run that removes this after the package is created. Something like grep -rn # noqa
There was a problem hiding this comment.
no shell script, but maybe something in the post-gen-hook
There was a problem hiding this comment.
@bobleesj Do you have any insight on how this might be done?
There was a problem hiding this comment.
Why did you add # noqa? The cookiecutter template doesn't require it:
"""Unit tests for __version__.py."""
import {{ cookiecutter.package_dir_name }} # noqa
def test_package_version():
"""Ensure the package version is defined and not set to the initial
placeholder."""
assert hasattr({{ cookiecutter.package_dir_name }}, "__version__")
assert {{ cookiecutter.package_dir_name }}.__version__ != "0.0.0"
``
| @@ -16,14 +12,3 @@ | |||
| # See LICENSE.rst for license information. | |||
| # | |||
| ############################################################################## | |||
| """diffpy - tools for structure analysis by diffraction. | |||
There was a problem hiding this comment.
An empty src/<namespacename>/__init__.py is still needed.
The namespace's``init.py, it's written in post_gen_hook.py` shown below:
def __gen_init__(module_name):
"""Generate __init__.py file for namespace module."""
__init__ = f"""#!/usr/bin/env python
##############################################################################
#
# (c) {% now 'utc', '%Y' %} The Trustees of Columbia University in the City of New York.
# All rights reserved.
#
# File coded by: Billinge Group members and community contributors.
#
# See GitHub contributions for a more detailed list of contributors.
# https://github.com/{{ cookiecutter.github_username_or_orgname }}/{{ cookiecutter.github_repo_name }}/graphs/contributors
#
# See LICENSE.rst for license information.
#
##############################################################################
""" # noqa: E999
return __init__
| @@ -1,6 +1,6 @@ | |||
| """Unit tests for __version__.py.""" | |||
|
|
|||
| import diffpy.utils | |||
| import diffpy.utils # noqa | |||
There was a problem hiding this comment.
Why did you add # noqa? The cookiecutter template doesn't require it:
"""Unit tests for __version__.py."""
import {{ cookiecutter.package_dir_name }} # noqa
def test_package_version():
"""Ensure the package version is defined and not set to the initial
placeholder."""
assert hasattr({{ cookiecutter.package_dir_name }}, "__version__")
assert {{ cookiecutter.package_dir_name }}.__version__ != "0.0.0"
``
|
The |
|
regarding the empty init, this was our question. Is just an empty init needed. Before in diffpy.utils we had some code about extending paths or something. I vaguely remember we managed to delete that and the namespace stuff all still worked, but I just wanted confirmation that my memory was correct, we don't need the delete "extend path" logic. |
Ok. I see it.
Yes, we deleted it and it works without it - both via pytest after deployed to pypi/conda-forge. |
Most files are default files modified by skpkg. no pre-commit edits were necessary.