Merge pull request #31 from openmc-data-storage/updated_setup

more modern python setup

Author: shimwell

.github/workflows/docker_ci_main.yml

@@ -21,7 +21,7 @@ jobs:
 
     - name: Setup package
       run: |
-        python setup.py install
+        pip install .
 
     - name: test test_command_line_usage.py
       run: |

.github/workflows/python-publish.yml

@@ -25,27 +25,16 @@ jobs:
       with:
         python-version: '3.x'
 
-    - name: Autobump version
-      run: |
-        # from refs/tags/v1.2.3 get 1.2.3
-        VERSION=$(echo $GITHUB_REF | sed 's#.*/v##')
-        PLACEHOLDER='version="develop"'
-        VERSION_FILE='setup.py'
-        # Grep checks that the placeholder is in the file. If grep doesn't find
-        # the placeholder then it exits with exit code 1 and github actions fails.
-        grep "$PLACEHOLDER" "$VERSION_FILE"
-        sed -i "s@$PLACEHOLDER@version=\"${VERSION}\"@g" "$VERSION_FILE"
-      shell: bash
-
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install setuptools wheel twine
+        pip install setuptools wheel build twine
 
     - name: Build and publish
       env:
         TWINE_USERNAME: __token__
         TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
       run: |
-        python setup.py sdist bdist_wheel
+        python -m build
+        twine check dist/*
         twine upload dist/*

.gitignore

@@ -130,4 +130,6 @@ dmypy.json
 
 # OpenMC files
 *.xml
-*.h5
+*.h5
+
+**_version.py

conda/meta.yaml

@@ -34,8 +34,9 @@ test:
   source_files:
     - tests/
   commands:
-    - pytest tests
-
+    - pytest tests/test_command_line_usage.py
+    - pytest tests/test_functions.py
+# test_use_in_openmc.py skipped for now as test is failing for upstream bug
 
 about:
   home: "https://github.com/openmc-data-storage/openmc_data_downloader"

openmc_data_downloader/__init__.py

@@ -1,3 +1,18 @@
+try:
+    # this works for python 3.7 and lower
+    from importlib.metadata import version, PackageNotFoundError
+except (ModuleNotFoundError, ImportError):
+    # this works for python 3.8 and higher
+    from importlib_metadata import version, PackageNotFoundError
+try:
+    __version__ = version("openmc_data_downloader")
+except PackageNotFoundError:
+    from setuptools_scm import get_version
+
+    __version__ = get_version(root="..", relative_to=__file__)
+
+__all__ = ["__version__"]
+
 from .cross_sections_directory import (
     NATURAL_ABUNDANCE,
     LIB_OPTIONS,

pyproject.toml

@@ -0,0 +1,10 @@
+[build-system]
+requires = [
+    "setuptools >= 46.4.0",
+    "wheel",
+    "setuptools_scm[toml] >= 6.3.1",
+]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]
+write_to = "openmc_data_downloader/_version.py"

setup.cfg

@@ -0,0 +1,41 @@
+[metadata]
+name = openmc_data_downloader
+version = attr: openmc_data_downloader.__version__
+author = The openmc_data_downloader Development Team
+author_email = [email protected]
+description = A tool for selectively downloading h5 files for specified isotopes / elements from your libraries of choice
+long_description = file: README.md
+long_description_content_type = text/markdown
+url = https://github.com/openmc-data-storage/openmc_data_downloader
+license = MIT
+license_file = LICENSE
+classifiers =
+    Natural Language :: English
+    Topic :: Scientific/Engineering
+    Programming Language :: Python :: 3
+    Programming Language :: Python :: 3.7
+    Programming Language :: Python :: 3.8
+    Programming Language :: Python :: 3.9
+    Programming Language :: Python :: 3.10
+    License :: OSI Approved :: MIT License
+    Operating System :: OS Independent
+project_urls =
+    Source = https://github.com/openmc-data-storage/openmc_data_downloader
+    Tracker = https://github.com/openmc-data-storage/openmc_data_downloader/issues
+
+[options]
+packages = find:
+scripts =
+    openmc_data_downloader/openmc_data_downloader
+python_requires= >=3.7
+install_requires=
+    pandas
+    retry
+     # 'openmc' is optional for this package but is not available via pip install at the moment
+
+[options.extras_require]
+tests = 
+    pytest >= 5.4.3
+
+[flake8]
+per-file-ignores = __init__.py:F401

setup.py

@@ -1,44 +1,4 @@
 import setuptools
 
-with open("README.md", "r") as fh:
-    long_description = fh.read()
-
-setuptools.setup(
-    name="openmc_data_downloader",
-    version="develop",
-    summary="Download cross section h5 files for use in OpenMC",
-    author="Jonathan Shimwell",
-    author_email="[email protected]",
-    description="A tool for selectively downloading h5 files for specified isotopes / elements from your libraries of choice",
-    long_description=long_description,
-    long_description_content_type="text/markdown",
-    url="https://github.com/openmc-data-storage/openmc_data_downloader",
-    packages=setuptools.find_packages(),
-    zip_safe=True,
-    package_dir={"openmc_data_downloader": "openmc_data_downloader"},
-    scripts=["openmc_data_downloader/openmc_data_downloader"],
-    package_data={
-        "openmc_data_downloader": [
-            "requirements.txt",
-            "README.md",
-            "LICENSE",
-        ]
-    },
-    classifiers=[
-        "Natural Language :: English",
-        "Topic :: Scientific/Engineering",
-        "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.6",
-        "Programming Language :: Python :: 3.7",
-        "Programming Language :: Python :: 3.8",
-        "Programming Language :: Python :: 3.9",
-        "License :: OSI Approved :: MIT License",
-        "Operating System :: OS Independent",
-    ],
-    tests_require=["pytest-cov", "pytest-runner"],
-    install_requires=[
-        "pandas",
-        "retry",
-        # 'openmc' is optional for this package but is not available via pip install at the moment
-    ],
-)
+if __name__ == "__main__":
+    setuptools.setup()