Fix creating and saving entries with upper case characters

doc/news/save_entry_case.rst

@@ -0,0 +1,3 @@
+**Fixed:**
+
+* Fixed creating and saving entries containing upper case characters, which are converted to lowercase, to match the frictionless specifications.

examples/from_csv/UpperCase.csv

@@ -0,0 +1,3 @@
+E,I
+1,2
+3,4

unitpackage/entry.py

@@ -627,6 +627,25 @@ def from_csv(cls, csvname, metadata=None, fields=None):
             >>> entry.user
             'Max Doe'
 
+        .. important::
+            Upper case filenames are converted to lower case entry identifiers!
+
+        A filename containing upper case characters::
+
+            >>> import os
+            >>> fields = [{'name':'E', 'unit': 'mV'}, {'name':'I', 'unit': 'A'}]
+            >>> entry = Entry.from_csv(csvname='examples/from_csv/UpperCase.csv', fields=fields)
+            >>> entry
+            Entry('uppercase')
+
+        Casing in the filename is preserved in the metadata::
+
+            >>> entry.resource # doctest: +NORMALIZE_WHITESPACE
+            {'name': 'uppercase',
+            'type': 'table',
+            'path': 'UpperCase.csv',
+            ...
+
         """
         from unitpackage.local import create_unitpackage
 
@@ -788,11 +807,23 @@ def from_df(cls, df, metadata=None, fields=None, outdir=None, *, basename):
 
             >>> entry.save(outdir='./test/generated/from_df')
 
-        TESTS
+        .. important::
+            Basenames with upper case characters are stored with lower case characters!
+            To separate words use underscores.
+
+        The basename will always be converted to lowercase entry identifiers::
+
+            >>> import pandas as pd
+            >>> from unitpackage.entry import Entry
+            >>> df = pd.DataFrame({'x':[1,2,3], 'y':[2,3,4]})
+            >>> entry = Entry.from_df(df=df, basename='TEST_DF')
+            >>> entry
+            Entry('test_df')
+
+        TESTS:
 
         Verify that all fields are properly created even when they are not specified as fields::
 
-            >>> import os
             >>> fields = [{'name':'x', 'unit': 'm'}, {'name':'P', 'unit': 'um'}, {'name':'E', 'unit': 'V'}]
             >>> metadata = {'user':'Max Doe'}
             >>> entry = Entry.from_df(df=df, basename='test_df', metadata=metadata, fields=fields)
@@ -832,9 +863,13 @@ def save(self, *, outdir, basename=None):
             True
 
         When a ``basename`` is set, the files are named ``basename.csv`` and ``basename.json``.
-        Note that for a valid frictionless Data Package this base name
-        MUST be lower-case and contain only alphanumeric
-        characters along with ".", "_" or "-" characters'::
+
+        .. note::
+            For a valid frictionless Data Package the basename
+            MUST be lower-case and contain only alphanumeric
+            characters along with ``.``, ``_`` or ``-`` characters'
+
+        A valid basename::
 
             >>> import os
             >>> entry = Entry.create_examples()[0]
@@ -843,10 +878,29 @@ def save(self, *, outdir, basename=None):
             >>> os.path.exists(f'test/generated/{basename}.json') and os.path.exists(f'test/generated/{basename}.csv')
             True
 
+        Upper case characters are saved lower case::
+
+            >>> import os
+            >>> import pandas as pd
+            >>> from unitpackage.entry import Entry
+            >>> df = pd.DataFrame({'x':[1,2,3], 'y':[2,3,4]})
+            >>> basename = 'Upper_Case_Save'
+            >>> entry = Entry.from_df(df=df, basename=basename)
+            >>> entry.save(outdir='./test/generated')
+            >>> os.path.exists(f'test/generated/{basename.lower()}.json') and os.path.exists(f'test/generated/{basename.lower()}.csv')
+            True
+
+            >>> new_entry = Entry.from_local(f'test/generated/{basename.lower()}.json')
+            >>> new_entry.resource # doctest: +NORMALIZE_WHITESPACE
+            {'name': 'upper_case_save',
+            'type': 'table',
+            'path': 'upper_case_save.csv',
+            ...
+
         TESTS:
 
         Save the entry as Data Package with metadata containing datetime format,
-        which is not natively supported by JSON.
+        which is not natively supported by JSON.::
 
             >>> import os
             >>> from datetime import datetime

unitpackage/local.py

@@ -176,7 +176,7 @@ def create_unitpackage(csvname, metadata=None, fields=None):
     )
     package.infer()
 
-    resource = package.get_resource(Path(csv_basename).stem)
+    resource = package.get_resource(Path(csv_basename).stem.lower())
 
     resource.custom.setdefault("metadata", {})
     resource.custom["metadata"].setdefault("echemdb", metadata)