Merge pull request #18 from NCAS-CMS/cleanup_bugfix_v0.1.1

TLC towards bugfix release v0.2.2

Author: valeriupredoi

cfs3/__init__.py

@@ -1,4 +1,16 @@
-__version__ = "0.2.1"
-
 from cfs3.cftools import MetaFix, FileNameFix, CFSplitter, CFuploader
-from cfs3.s3cmd import s3cmd
+from cfs3.s3cmd import s3cmd
+from importlib.metadata import version
+from importlib.metadata import PackageNotFoundError
+
+
+try:
+    __version__ = version("cfs3")
+except PackageNotFoundError as exc:
+    msg = (
+        "cfs3 package not found, please run `pip install -e .` before "
+        "importing the package."
+    )
+    raise PackageNotFoundError(
+        msg,
+    ) from exc

environment.yml

@@ -16,8 +16,8 @@ dependencies:
   - udunits2
   # for tests
   - pytest
-  - pytest-html !=2.1.0
-  - pytest-metadata >=1.5.1
+  - pytest-html
+  - pytest-metadata
   - pytest-mock
   - pytest-xdist
   # for docs

pyproject.toml

@@ -1,7 +1,7 @@
 [build-system]
 requires = [
-    "setuptools>=40.6.0",
-    "setuptools_scm>=6.2",
+    "setuptools>=80",
+    "setuptools_scm>=8",
 ]
 build-backend = "setuptools.build_meta"
 
@@ -12,7 +12,6 @@ authors = [
 classifiers = [
     "Environment :: Console",
     "Intended Audience :: Science/Research",
-    "License :: OSI Approved :: BSD License",
     "Natural Language :: English",
     "Operating System :: POSIX :: Linux",
     "Programming Language :: Python :: 3",
@@ -27,16 +26,17 @@ dynamic = [
     "version",
 ]
 dependencies = [
-    'cmd2>2',
-    'pyreadline3;platform_system=="Windows"',
-    'minio',
     'bitmath',
     'cf-python',
-    'pyfive',
+    'cmd2>2',
     'fsspec',
+    'minio',
+    'pyfive',
+    'pyreadline3;platform_system=="Windows"',
 ]
 description = "Lightweight tool for investigating data files in an s3 repository"
-license = {text = "BSD License, Version 3-Clause"}
+license = "BSD-3-Clause"
+license-files = ["LICENSE.txt"]
 name = "cfs3"
 requires-python = ">=3.10"
 
@@ -45,9 +45,11 @@ s3view = "cfs3.s3view:main"
 
 [project.optional-dependencies]
 test = [
+   'docker',
    'pytest',
+   'pytest-metadata',
    'pytest-mock',
-   'docker'
+   'pytest-xdist',
 ]
 dev = [
     'pytest',
@@ -72,10 +74,7 @@ doc = [
 # Documentation = ""
 
 [tool.setuptools]
-include-package-data = true
-license-files = ["LICENSE"]
 packages = ["cfs3"]
-zip-safe = false  # possibly yes
 
 [tool.setuptools.dynamic]
 readme = {file = "README.md", content-type = "text/markdown"}

tests/test_s3v.py

@@ -5,8 +5,6 @@
 import json
 import io
 
-#import cmd2
-#cmd2.ansi.allow_style = cmd2.ansi.AllowStyle.NEVER
 
 dummy_config = '{"aliases":{"loc1":{"url":"https://blah.com","accessKey":"a key","secretKey":"b key","api":"S3v4"}}}'