ccfx 0.4.0__py3-none-any.whl → 0.5.0__py3-none-any.whl

ccfx/ccfx.py

@@ -27,7 +27,8 @@ from osgeo import gdal, ogr, osr
 import py7zr
 import subprocess
 import multiprocessing
-
+from mutagen.mp3 import MP3
+from mutagen.id3 import ID3, TPE1, TALB, TIT2, TRCK, TDRC, TCON, APIC, COMM, USLT, TPE2, TCOM, TPE3, TPE4, TCOP, TENC, TSRC, TBPM
 
 
 # functions
@@ -63,6 +64,138 @@ def getExtension(filePath:str) -> str:
     return os.path.splitext(filePath)[1].lstrip('.')
 
 
+def getMp3Metadata(fn, imagePath=None):
+    '''
+    This function takes a path to mp3 and returns a dictionary with
+    the following keys:
+    - artist, album, title, track number, year, genre
+    '''
+    metadata = {}
+    
+    try:
+        audio = MP3(fn, ID3=ID3)
+        
+        if 'TPE1' in audio.tags: metadata['artist'] = str(audio.tags['TPE1'])
+        else: metadata['artist'] = "Unknown Artist"
+            
+        if 'TALB' in audio.tags: metadata['album'] = str(audio.tags['TALB'])
+        else: metadata['album'] = "Unknown Album"
+            
+        if 'TIT2' in audio.tags: metadata['title'] = str(audio.tags['TIT2'])
+        else: metadata['title'] = os.path.basename(fn).replace('.mp3', '')
+            
+        if 'TRCK' in audio.tags: metadata['track_number'] = str(audio.tags['TRCK'])
+        else: metadata['track_number'] = "0"
+            
+        if 'TDRC' in audio.tags: metadata['year'] = str(audio.tags['TDRC'])
+        else: metadata['year'] = "Unknown Year"
+            
+        if 'TCON' in audio.tags: metadata['genre'] = str(audio.tags['TCON'])
+        else: metadata['genre'] = "Unknown Genre"
+
+        if imagePath is not None:
+            foundImage = False
+            if audio.tags:
+                for tagKey in audio.tags.keys():
+                    if tagKey.startswith("APIC:"):
+                        with open(imagePath, 'wb') as img_file:
+                            img_file.write(audio.tags[tagKey].data)
+                        foundImage = True
+                        break
+            if not foundImage:
+                print("No image found in metadata.")
+    
+    except Exception as e:
+        print(f"Error extracting metadata from {fn}: {e}")
+        # Set default values if extraction fails
+        metadata = {
+            'artist': "Unknown Artist",
+            'album': "Unknown Album",
+            'title': os.path.basename(fn).replace('.mp3', ''),
+            'track_number': "0",
+            'year': "Unknown Year",
+            'genre': "Unknown Genre"
+        }
+    
+    return metadata
+
+def guessMimeType(imagePath):
+    ext = os.path.splitext(imagePath.lower())[1]
+    if ext in ['.jpg', '.jpeg']:
+        return 'image/jpeg'
+    elif ext == '.png':
+        return 'image/png'
+    return 'image/png'
+
+def setMp3Metadata(fn, metadata, imagePath=None):
+    '''
+    This function takes a path to an mp3 and a metadata dictionary,
+    then writes that metadata to the file's ID3 tags.
+    
+    The metadata dictionary should have these keys:
+    - artist, album, title, track_number, year, genre
+    
+    Additionally, an optional imagePath parameter can be provided to
+    attach album artwork from a PNG or JPEG file.
+    
+    Alternatively, you can include an 'imagePath' key in the metadata
+    dictionary instead of using the separate parameter.
+    '''
+    try:
+        # Try to load existing ID3 tags or create new ones if they don't exist
+        try:
+            audio = ID3(fn)
+        except:
+            audio = ID3()
+            
+        # Set artist
+        if 'artist' in metadata and metadata['artist']: audio['TPE1'] = TPE1(encoding=3, text=metadata['artist'])
+        if 'album' in metadata and metadata['album']: audio['TALB'] = TALB(encoding=3, text=metadata['album'])
+        if 'title' in metadata and metadata['title']: audio['TIT2'] = TIT2(encoding=3, text=metadata['title'])
+        if 'track_number' in metadata and metadata['track_number']: audio['TRCK'] = TRCK(encoding=3, text=metadata['track_number'])
+        if 'year' in metadata and metadata['year']: audio['TDRC'] = TDRC(encoding=3, text=metadata['year'])
+        if 'genre' in metadata and metadata['genre']: audio['TCON'] = TCON(encoding=3, text=metadata['genre'])
+        if 'comment' in metadata and metadata['comment']: audio['COMM'] = COMM(encoding=3, text=metadata['comment'])
+        if 'lyrics' in metadata and metadata['lyrics']: audio['USLT'] = USLT(encoding=3, text=metadata['lyrics'])
+        if 'publisher' in metadata and metadata['publisher']: audio['TPUB'] = TPE2(encoding=3, text=metadata['publisher'])
+        if 'composer' in metadata and metadata['composer']: audio['TCOM'] = TCOM(encoding=3, text=metadata['composer'])
+        if 'conductor' in metadata and metadata['conductor']: audio['TPE3'] = TPE3(encoding=3, text=metadata['conductor'])
+        if 'performer' in metadata and metadata['performer']: audio['TPE4'] = TPE4(encoding=3, text=metadata['performer'])
+        if 'copyright' in metadata and metadata['copyright']: audio['TCOP'] = TCOP(encoding=3, text=metadata['copyright'])
+        if 'encoded_by' in metadata and metadata['encoded_by']: audio['TENC'] = TENC(encoding=3, text=metadata['encoded_by'])
+        if 'encoder' in metadata and metadata['encoder']: audio['TENC'] = TENC(encoding=3, text=metadata['encoder'])
+        if 'isrc' in metadata and metadata['isrc']: audio['TSRC'] = TSRC(encoding=3, text=metadata['isrc'])
+        if 'bpm' in metadata and metadata['bpm']: audio['TBPM'] = TBPM(encoding=3, text=metadata['bpm'])
+        # Check if image path is in metadata dictionary and not provided as parameter
+        if imagePath is None and 'imagePath' in metadata:
+            imagePath = metadata['imagePath']
+        
+        # Attach image if provided
+        if imagePath and os.path.exists(imagePath):
+            with open(imagePath, 'rb') as img_file:
+                img_data = img_file.read()
+                
+            # Determine image MIME type
+            mime = guessMimeType(imagePath)
+                
+            # Create APIC frame for album artwork
+            audio['APIC'] = APIC(
+                encoding=3,         # UTF-8 encoding
+                mime=mime,          # MIME type of the image
+                type=3,             # 3 means 'Cover (front)'
+                desc='Cover',       # Description
+                data=img_data       # The image data
+            )
+                
+        # Save changes to the file
+        audio.save(fn)
+        return True
+    
+    except Exception as e:
+        print(f"Error writing metadata to {fn}: {e}")
+        return False
+
+
 def deleteFile(filePath:str, v:bool = False) -> bool:
     '''
     Delete a file
@@ -439,8 +572,11 @@ def moveDirectoryFiles(srcDir: str, destDir: str, v: bool = False) -> bool:
             src_file = os.path.join(root, file)
             dest_file = os.path.join(dest_root, file)
             if v:
-                print(f"\t> Moving file \n\t - {src_file}\n\t - to {dest_file}")
-            shutil.move(src_file, dest_file)
+                print(f"\t> Moving file \n\t - {src_file}\n\t     to {dest_file}")
+            try:
+                shutil.move(src_file, dest_file)
+            except Exception as e:
+                print(f"! Error moving file: {e}")
 
     return True
 
@@ -1314,4 +1450,25 @@ def getMSE(data:pandas.DataFrame, observed:str = None, simulated:str = None, res
 
     return stats['MSE']
 
+def getTimeseriesStats(data:pandas.DataFrame, observed:str = None, simulated:str = None, resample:str = None ) -> dict:
+    '''
+    this function is a wrapper for calculateTimeseriesStats specifically to return all stats
+
+    data: pandas.DataFrame
+        DataFrame containing the timeseries data
+    observed: str
+        name of the observed column
+    simulated: str
+        name of the simulated column
+    resample: str
+        if specified, the data will be resampled to the specified frequency
+        available options: 'H' (hourly), 'D' (daily), 'M' (monthly), 'Y' (yearly)
+
+    return: dict
+        dictionary containing all stats
+    '''
+    stats = calculateTimeseriesStats(data, observed, simulated, resample)
+
+    return stats
+
 ignoreWarnings()

{ccfx-0.4.0.dist-info → ccfx-0.5.0.dist-info}/METADATA

@@ -1,146 +1,148 @@
-Metadata-Version: 2.1
-Name: ccfx
-Version: 0.4.0
-Summary: This package implifies regular coommon actions for quick prototyping in a user friendly way
-Author-email: Celray James CHAWANDA <celray@chawanda.com>
-License: MIT
-Project-URL: Homepage, https://github.com/celray/ccfx
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: netCDF4
-Requires-Dist: gdal
-Requires-Dist: numpy
-Requires-Dist: shapely
-Requires-Dist: geopandas
-Requires-Dist: pandas
-Requires-Dist: xlsxwriter
-Requires-Dist: pyodbc
-Requires-Dist: sqlalchemy
-Requires-Dist: python-docx
-Requires-Dist: py7zr
-
-# ccfx
-
-`ccfx` is a comprehensive Python package designed to streamline file and data management, geospatial analysis, and NetCDF file processing for quick prototyping. The library provides versatile tools for file handling, raster and vector manipulation, database connectivity, and data export for geospatial and scientific computing projects.
-
-## Features
-
-1. **File Management**:
-   - List, delete, move, and count files within directories.
-   - Monitor file count over time in a specific directory.
-   - Save, load, and manage Python variables via pickle serialization.
-
-2. **Geospatial Data Processing**:
-   - Read, write, and manage raster and vector geospatial data.
-   - Clip rasters by bounding boxes and extract raster values at specified coordinates.
-   - Create grids of polygons based on shapefile boundaries with user-defined resolutions.
-   - Convert coordinates between coordinate reference systems (CRS).
-   - Write NumPy arrays to GeoTIFF files with projection and geotransform settings.
-
-3. **NetCDF File Handling**:
-   - List available variables and dimensions in NetCDF files.
-   - Export NetCDF variables to GeoTIFF format.
-   - Calculate sum and average maps from NetCDF data across multiple files.
-
-4. **Database Connectivity**:
-   - Access and interact with databases using ODBC and SQLAlchemy for flexible database management.
-   - Connect to both SQL Server and SQLite databases.
-
-5. **Progress Tracking and System Info**:
-   - Display dynamic progress bars for long-running operations.
-   - Check the system’s platform information.
-   - Enable or disable warnings programmatically.
-
-6. **Excel and Word File Handling**:
-   - Create and modify Excel files using xlsxwriter.
-   - Generate Word documents with advanced formatting options using python-docx.
-
-## Installation
-
-Install `ccfx` via pip:
-```bash
-pip install ccfx
-```
-
-## Dependencies
-
-`ccfx` relies on the following libraries:
-
-- **netCDF4**: For working with NetCDF files.
-- **gdal**: Required for geospatial raster data manipulation.
-- **numpy**: For array processing and numerical operations.
-- **pandas**: For data manipulation and analysis.
-- **shapely**: Provides geometric operations for spatial data.
-- **geopandas**: Extends pandas to handle geospatial data.
-- **xlsxwriter**: For creating and writing Excel files.
-- **pyodbc**: Enables connectivity to databases through ODBC.
-- **sqlalchemy**: Provides SQL toolkit and ORM features for database access.
-- **python-docx**: Enables creation and manipulation of Word documents.
-
-These dependencies will be installed automatically when `ccfx` is installed.
-
-## API Reference
-
-### `listFiles(path: str, ext: str = None) -> list`
-Lists all files in a directory with a specified extension.
-
-- **Parameters**:
-  - `path` (str): The directory to search.
-  - `ext` (str, optional): File extension to filter by, e.g., `'txt'`, `'.txt'`, `'*txt'`, or `'*.txt'`.
-
-- **Returns**:
-  - `list`: A list of file paths matching the criteria.
-
-### `deleteFile(filePath: str, v: bool = False) -> bool`
-Deletes a specified file with optional verbose output.
-
-- **Parameters**:
-  - `filePath` (str): Path to the file to be deleted.
-  - `v` (bool, optional): If `True`, prints a confirmation message. Defaults to `False`.
-
-- **Returns**:
-  - `bool`: `True` if deletion was successful; `False` otherwise.
-
-### `createGrid(shapefile_path: str, resolution: float, useDegree: bool = True) -> tuple`
-Generates a grid of polygons from a shapefile at a given resolution.
-
-- **Parameters**:
-  - `shapefile_path` (str): Path to the shapefile.
-  - `resolution` (float): Resolution of the grid.
-  - `useDegree` (bool, optional): If `True`, coordinates are in degrees. Defaults to `True`.
-
-- **Returns**:
-  - `tuple`: Contains grid coordinates and metadata.
-
-### `clipRasterByExtent(inFile: str, outFile: str, bounds: tuple) -> str`
-Clips a raster to specified bounding box coordinates.
-
-- **Parameters**:
-  - `inFile` (str): Path to the input raster file.
-  - `outFile` (str): Path to the output clipped raster file.
-  - `bounds` (tuple): Bounding box as `(minx, miny, maxx, maxy)`.
-
-- **Returns**:
-  - `str`: Path to the clipped raster file.
-
-### `netcdfVariablesList(ncFile: str) -> list`
-Lists all variables in a NetCDF file.
-
-- **Parameters**:
-  - `ncFile` (str): Path to the NetCDF file.
-
-- **Returns**:
-  - `list`: A list of variable names in the file.
-
-### ... And More ...
-
-## Contributing
-
-Contributions are welcome! Please fork the repository, make your changes, and submit a pull request.
-
-## License
-This project is licensed under the MIT License.
+Metadata-Version: 2.4
+Name: ccfx
+Version: 0.5.0
+Summary: This package simplifies regular common actions for quick prototyping in a user friendly way
+Author-email: Celray James CHAWANDA <celray@chawanda.com>
+License: MIT
+Project-URL: Homepage, https://github.com/celray/ccfx
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: netCDF4
+Requires-Dist: gdal
+Requires-Dist: numpy
+Requires-Dist: shapely
+Requires-Dist: geopandas
+Requires-Dist: pandas
+Requires-Dist: xlsxwriter
+Requires-Dist: pyodbc
+Requires-Dist: sqlalchemy
+Requires-Dist: python-docx
+Requires-Dist: py7zr
+Requires-Dist: mutagen
+Dynamic: license-file
+
+# ccfx
+
+`ccfx` is a comprehensive Python package designed to streamline file and data management, geospatial analysis, and NetCDF file processing for quick prototyping. The library provides versatile tools for file handling, raster and vector manipulation, database connectivity, and data export for geospatial and scientific computing projects.
+
+## Features
+
+1. **File Management**:
+   - List, delete, move, and count files within directories.
+   - Monitor file count over time in a specific directory.
+   - Save, load, and manage Python variables via pickle serialization.
+
+2. **Geospatial Data Processing**:
+   - Read, write, and manage raster and vector geospatial data.
+   - Clip rasters by bounding boxes and extract raster values at specified coordinates.
+   - Create grids of polygons based on shapefile boundaries with user-defined resolutions.
+   - Convert coordinates between coordinate reference systems (CRS).
+   - Write NumPy arrays to GeoTIFF files with projection and geotransform settings.
+
+3. **NetCDF File Handling**:
+   - List available variables and dimensions in NetCDF files.
+   - Export NetCDF variables to GeoTIFF format.
+   - Calculate sum and average maps from NetCDF data across multiple files.
+
+4. **Database Connectivity**:
+   - Access and interact with databases using ODBC and SQLAlchemy for flexible database management.
+   - Connect to both SQL Server and SQLite databases.
+
+5. **Progress Tracking and System Info**:
+   - Display dynamic progress bars for long-running operations.
+   - Check the system’s platform information.
+   - Enable or disable warnings programmatically.
+
+6. **Excel and Word File Handling**:
+   - Create and modify Excel files using xlsxwriter.
+   - Generate Word documents with advanced formatting options using python-docx.
+
+## Installation
+
+Install `ccfx` via pip:
+```bash
+pip install ccfx
+```
+
+## Dependencies
+
+`ccfx` relies on the following libraries:
+
+- **netCDF4**: For working with NetCDF files.
+- **gdal**: Required for geospatial raster data manipulation.
+- **numpy**: For array processing and numerical operations.
+- **pandas**: For data manipulation and analysis.
+- **shapely**: Provides geometric operations for spatial data.
+- **geopandas**: Extends pandas to handle geospatial data.
+- **xlsxwriter**: For creating and writing Excel files.
+- **pyodbc**: Enables connectivity to databases through ODBC.
+- **sqlalchemy**: Provides SQL toolkit and ORM features for database access.
+- **python-docx**: Enables creation and manipulation of Word documents.
+
+These dependencies will be installed automatically when `ccfx` is installed.
+
+## API Reference
+
+### `listFiles(path: str, ext: str = None) -> list`
+Lists all files in a directory with a specified extension.
+
+- **Parameters**:
+  - `path` (str): The directory to search.
+  - `ext` (str, optional): File extension to filter by, e.g., `'txt'`, `'.txt'`, `'*txt'`, or `'*.txt'`.
+
+- **Returns**:
+  - `list`: A list of file paths matching the criteria.
+
+### `deleteFile(filePath: str, v: bool = False) -> bool`
+Deletes a specified file with optional verbose output.
+
+- **Parameters**:
+  - `filePath` (str): Path to the file to be deleted.
+  - `v` (bool, optional): If `True`, prints a confirmation message. Defaults to `False`.
+
+- **Returns**:
+  - `bool`: `True` if deletion was successful; `False` otherwise.
+
+### `createGrid(shapefile_path: str, resolution: float, useDegree: bool = True) -> tuple`
+Generates a grid of polygons from a shapefile at a given resolution.
+
+- **Parameters**:
+  - `shapefile_path` (str): Path to the shapefile.
+  - `resolution` (float): Resolution of the grid.
+  - `useDegree` (bool, optional): If `True`, coordinates are in degrees. Defaults to `True`.
+
+- **Returns**:
+  - `tuple`: Contains grid coordinates and metadata.
+
+### `clipRasterByExtent(inFile: str, outFile: str, bounds: tuple) -> str`
+Clips a raster to specified bounding box coordinates.
+
+- **Parameters**:
+  - `inFile` (str): Path to the input raster file.
+  - `outFile` (str): Path to the output clipped raster file.
+  - `bounds` (tuple): Bounding box as `(minx, miny, maxx, maxy)`.
+
+- **Returns**:
+  - `str`: Path to the clipped raster file.
+
+### `netcdfVariablesList(ncFile: str) -> list`
+Lists all variables in a NetCDF file.
+
+- **Parameters**:
+  - `ncFile` (str): Path to the NetCDF file.
+
+- **Returns**:
+  - `list`: A list of variable names in the file.
+
+### ... And More ...
+
+## Contributing
+
+Contributions are welcome! Please fork the repository, make your changes, and submit a pull request.
+
+## License
+This project is licensed under the MIT License.

ccfx-0.5.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+ccfx/__init__.py,sha256=VmBeF3oj6JTJ_793d4i8PvhyF8_FxaxA1L_FmHWqitc,142
+ccfx/ccfx.py,sha256=A61uV0bKlusLAcLlgNVhKaMQ4KutWxB7hzEQnitJpus,51808
+ccfx/excel.py,sha256=cQ4TQW49XqbMB3sSS0IOhO3-WArIolEBIrvOvhFyPtI,4757
+ccfx/mssqlConnection.py,sha256=TwyZXhHHI7zy6BSfH1pszuHVJ5cmndRC5dVxvEtSTks,7904
+ccfx/sqliteConnection.py,sha256=jEJ94D5ySt84N7AeDpa27Rclt1NaKhkX6nYzidwApIg,11104
+ccfx/word.py,sha256=AGa64jX5Zl5qotZh5L0QmrsjTnktIBhmj_ByRKZ88vw,3061
+ccfx-0.5.0.dist-info/licenses/LICENSE,sha256=2-M3fBUS3FmrSIrqd3cZDmxXxojWVJtZY-SHSRE6RxM,1098
+ccfx-0.5.0.dist-info/METADATA,sha256=6tpyj3FwWBdkm8BCvU26J9rZFsP_mCIoZUxTb71GYRA,5381
+ccfx-0.5.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+ccfx-0.5.0.dist-info/top_level.txt,sha256=_cSvSA1WX2K8TgoV3iBJUdUZZqMKJbOPLNnKLYSLHaw,5
+ccfx-0.5.0.dist-info/RECORD,,

{ccfx-0.4.0.dist-info → ccfx-0.5.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.6.0)
+Generator: setuptools (78.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

ccfx-0.4.0.dist-info/RECORD

@@ -1,11 +0,0 @@
-ccfx/__init__.py,sha256=VmBeF3oj6JTJ_793d4i8PvhyF8_FxaxA1L_FmHWqitc,142
-ccfx/ccfx.py,sha256=TcGb46QY57295iRfRnMwdm_fjjQ1Z-VDDlzveahRoEw,44547
-ccfx/excel.py,sha256=cQ4TQW49XqbMB3sSS0IOhO3-WArIolEBIrvOvhFyPtI,4757
-ccfx/mssqlConnection.py,sha256=TwyZXhHHI7zy6BSfH1pszuHVJ5cmndRC5dVxvEtSTks,7904
-ccfx/sqliteConnection.py,sha256=jEJ94D5ySt84N7AeDpa27Rclt1NaKhkX6nYzidwApIg,11104
-ccfx/word.py,sha256=AGa64jX5Zl5qotZh5L0QmrsjTnktIBhmj_ByRKZ88vw,3061
-ccfx-0.4.0.dist-info/LICENSE,sha256=2-M3fBUS3FmrSIrqd3cZDmxXxojWVJtZY-SHSRE6RxM,1098
-ccfx-0.4.0.dist-info/METADATA,sha256=3llLy7xyGpG1tpvmB9LZc4csbq-R41UoGMlR95ajT-s,5482
-ccfx-0.4.0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-ccfx-0.4.0.dist-info/top_level.txt,sha256=_cSvSA1WX2K8TgoV3iBJUdUZZqMKJbOPLNnKLYSLHaw,5
-ccfx-0.4.0.dist-info/RECORD,,