ccfx 1.0.7__tar.gz → 1.0.8__tar.gz

{ccfx-1.0.7/ccfx.egg-info → ccfx-1.0.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ccfx
-Version: 1.0.7
+Version: 1.0.8
 Summary: This package simplifies regular common actions for quick prototyping in a user friendly way
 Author-email: Celray James CHAWANDA <celray@chawanda.com>
 License-Expression: MIT

{ccfx-1.0.7 → ccfx-1.0.8}/ccfx/ccfx.py

@@ -35,7 +35,7 @@ import math
 import requests
 from tqdm import tqdm
 import yt_dlp
-from typing import Optional
+from typing import Optional, Any
 from datetime import datetime, timedelta
 from PIL import Image
 
@@ -72,7 +72,7 @@ def getExtension(filePath:str) -> str:
     return os.path.splitext(filePath)[1].lstrip('.')
 
 
-def getMp3Metadata(fn, imagePath=None):
+def getMp3Metadata(fn: str, imagePath: Optional[str] = None) -> dict:
     '''
     This function takes a path to mp3 and returns a dictionary with
     the following keys:
@@ -127,7 +127,7 @@ def getMp3Metadata(fn, imagePath=None):
     return metadata
     
 
-def guessMimeType(imagePath):
+def guessMimeType(imagePath: str) -> str:
     ext = os.path.splitext(imagePath.lower())[1]
     if ext in ['.jpg', '.jpeg']:
         return 'image/jpeg'
@@ -240,7 +240,7 @@ def parseYoutubeChannelVideos(channelUrl: str, maxItems: Optional[int] = None) -
     return [f"https://www.youtube.com/watch?v={e['id']}" for e in entries if e.get("id")]
 
 
-def runSWATPlus(txtinoutDir: str, finalDir: str, executablePath: str = "swatplus", v: bool = True):
+def runSWATPlus(txtinoutDir: str, finalDir: str, executablePath: str = "swatplus", v: bool = True) -> None:
     os.chdir(txtinoutDir)
 
     if not v:
@@ -339,7 +339,7 @@ def formatTimedelta(delta: timedelta) -> str:
         return f"{time_fmt}"
 
 
-def setMp3Metadata(fn, metadata, imagePath=None):
+def setMp3Metadata(fn: str, metadata: dict, imagePath: Optional[str] = None) -> bool:
     '''
     This function takes a path to an mp3 and a metadata dictionary,
     then writes that metadata to the file's ID3 tags.
@@ -434,7 +434,7 @@ def deleteFile(filePath:str, v:bool = False) -> bool:
     
     return deleted
 
-def removeImageColour(inPath:str, outPath:str, colour:tuple = (255, 255, 255), tolerance:int = 30):
+def removeImageColour(inPath:str, outPath:str, colour:tuple = (255, 255, 255), tolerance:int = 30) -> None:
     '''
     Remove a specific color from an image.
     colour: RGB tuple, e.g., (255, 0, 0) for red
@@ -457,7 +457,7 @@ def removeImageColour(inPath:str, outPath:str, colour:tuple = (255, 255, 255), t
     img.putdata(new_data)
     img.save(outPath)
 
-def makeTransparent(inPath:str, outPath:str, colour:tuple = (255, 255, 255), tolerance:int = 30):
+def makeTransparent(inPath:str, outPath:str, colour:tuple = (255, 255, 255), tolerance:int = 30) -> None:
     '''
     Make some pixels in an image transparent.
     '''
@@ -519,7 +519,7 @@ def deletePath(path:str, v:bool = False) -> bool:
         deleted = False
 
 
-def downloadChunk(url, start, end, path):
+def downloadChunk(url: str, start: int, end: int, path: str) -> None:
     headers = {'Range': f'bytes={start}-{end}'}
     response = requests.get(url, headers=headers, stream=True)
     with open(path, 'wb') as f:
@@ -528,7 +528,7 @@ def downloadChunk(url, start, end, path):
                 f.write(chunk)
 
 
-def formatStringBlock(input_str, max_chars=70):
+def formatStringBlock(input_str: str, max_chars: int = 70) -> str:
     '''
     This function takes a string and formats it into a block of text
     with a maximum number of characters per line.
@@ -559,7 +559,7 @@ def formatStringBlock(input_str, max_chars=70):
 
 
 
-def downloadFile(url, save_path, exists_action='resume', num_connections=5, v=False):
+def downloadFile(url: str, save_path: str, exists_action: str = 'resume', num_connections: int = 5, v: bool = False) -> None:
     if v:
         print(f"\ndownloading {url}")
     fname = getFileBaseName(url, extension=True)
@@ -649,7 +649,7 @@ def systemPlatform() -> str:
     '''
     return platform.system()
 
-def progressBar(count, total, message=""):
+def progressBar(count: int, total: int, message: str = "") -> None:
     percent = int(count / total * 100)
     filled = int(percent / 2)
     bar = '█' * filled + '░' * (50 - filled)
@@ -669,7 +669,7 @@ def fileCount(path:str = "./", extension:str = ".*", v:bool = True) -> int:
         print(f'> there are {count} {extension if not extension ==".*" else ""} files in {path}')
     return count
 
-def resampleRaster(inFile:str, outFile:str, resolution:float, dstSRS = None, resamplingMethod = 'bilinear', replaceOutput:bool = True, v:bool = True) -> str:
+def resampleRaster(inFile:str, outFile:str, resolution:float, dstSRS = None, resamplingMethod = 'bilinear', replaceOutput:bool = True, v:bool = True) -> Optional[str]:
     '''
     Resample a raster file
     inFile: input raster file
@@ -740,7 +740,7 @@ def watchFileCount(path:str="./", extension:str = ".*", interval:float = 0.2, du
     return None
 
 
-def pythonVariable(filename, option, variable=None):
+def pythonVariable(filename: str, option: str, variable: Any = None) -> Any:
     '''
     option: save, load or open
 
@@ -774,7 +774,7 @@ def listFolders(path:str) -> list:
     else:
         return []
 
-def readFrom(filename, decode_codec = None, v=False):
+def readFrom(filename: str, decode_codec: Optional[str] = None, v: bool = False) -> Any:
     '''
     a function to read ascii files
     '''
@@ -793,16 +793,16 @@ def readFrom(filename, decode_codec = None, v=False):
 
 
 def pointsToGeodataframe(
-    rowList,
-    columnNames,
-    latIndex,
-    lonIndex,
-    auth = "EPSG",
-    code = "4326",
-    outShape = "",
-    format = "gpkg",
-    v = False,
-    includeLatLon = True ) -> geopandas.GeoDataFrame:
+    rowList: list,
+    columnNames: list,
+    latIndex: int,
+    lonIndex: int,
+    auth: str = "EPSG",
+    code: str = "4326",
+    outShape: str = "",
+    format: str = "gpkg",
+    v: bool = False,
+    includeLatLon: bool = True ) -> geopandas.GeoDataFrame:
     df = pandas.DataFrame(rowList, columns = columnNames)
     geometry = [
         Point(row[lonIndex], row[latIndex]) for row in rowList
@@ -824,10 +824,10 @@ def pointsToGeodataframe(
     return gdf
 
 
-def readFile(filename, decode_codec = None, v=False):
+def readFile(filename: str, decode_codec: Optional[str] = None, v: bool = False) -> Any:
     return readFrom(filename, decode_codec, v)
 
-def writeTo(filename, file_text, encode_codec = None, v=False) -> bool:
+def writeTo(filename: str, file_text: Any, encode_codec: Optional[str] = None, v: bool = False) -> bool:
     '''
     a function to write ascii files
     '''
@@ -846,13 +846,13 @@ def writeTo(filename, file_text, encode_codec = None, v=False) -> bool:
     if v: print("\t> wrote {0}".format(getFileBaseName(filename, extension=True)))
     return True
 
-def writeToFile(filename, file_text, encode_codec = None, v=False) -> bool:
+def writeToFile(filename: str, file_text: Any, encode_codec: Optional[str] = None, v: bool = False) -> bool:
     return writeTo(filename, file_text, encode_codec, v)
 
-def writeFile(filename, file_text, encode_codec = None, v=False) -> bool:
+def writeFile(filename: str, file_text: Any, encode_codec: Optional[str] = None, v: bool = False) -> bool:
     return writeTo(filename, file_text, encode_codec, v)
 
-def createPath(pathName, v = False):
+def createPath(pathName: str, v: bool = False) -> str:
     '''
     this function creates a directory if it does not exist
     pathName: the path to create
@@ -871,7 +871,7 @@ def createPath(pathName, v = False):
     return pathName
 
 
-def renameNetCDFvariable(input_file: str, output_file: str, old_var_name: str, new_var_name: str, v = False) -> None:
+def renameNetCDFvariable(input_file: str, output_file: str, old_var_name: str, new_var_name: str, v: bool = False) -> None:
     """
     Renames a variable in a NetCDF file using CDO if it exists.
     If the variable does not exist, the file is copied without modification.
@@ -907,7 +907,7 @@ def renameNetCDFvariable(input_file: str, output_file: str, old_var_name: str, n
         print(f"Error: {e.stderr}")
 
 
-def compressTo7z(input_dir: str, output_file: str, compressionLevel: int = 4, excludeExt: list = None, v: bool = False) -> None:
+def compressTo7z(input_dir: str, output_file: str, compressionLevel: int = 4, excludeExt: Optional[list] = None, v: bool = False) -> None:
     """
     Compresses the contents of a directory to a .7z archive with maximum compression.
     
@@ -1210,8 +1210,8 @@ def ignoreWarnings(ignore:bool = True, v:bool = False) -> None:
     return None
 
 
-def createGrid(topLeft: list = None, bottomRight: list = None, resolution: float = None, 
-               inputShape: str = None, crs: str = "EPSG:4326", saveVector: str = None) -> geopandas.GeoDataFrame:
+def createGrid(topLeft: Optional[list] = None, bottomRight: Optional[list] = None, resolution: Optional[float] = None, 
+               inputShape: Optional[str] = None, crs: str = "EPSG:4326", saveVector: Optional[str] = None) -> geopandas.GeoDataFrame:
     '''
     This function creates a grid of polygons based on either a shapefile or corner coordinates
     
@@ -1341,7 +1341,7 @@ def netcdfVariableDimensions(ncFile: str, variable: str) -> dict:
     
     return bands_info
 
-def netcdfExportTif(ncFile: str, variable: str, outputFile: Optional[str] = None, band: int = None, v:bool = True) -> gdal.Dataset:
+def netcdfExportTif(ncFile: str, variable: str, outputFile: Optional[str] = None, band: Optional[int] = None, v:bool = True) -> gdal.Dataset:
     '''
     Export a variable from a NetCDF file to a GeoTiff file
     ncFile: NetCDF file
@@ -1401,8 +1401,8 @@ def netcdfSumMaps(ncFiles:list, variable:str, band:int = 1) -> numpy.ndarray:
 def tiffWriteArray(array: numpy.ndarray, outputFile: str, 
                      geoTransform: tuple = (0, 1, 0, 0, 0, -1), 
                      projection: str = 'EPSG:4326',
-                     noData:float = None,
-                     v:bool = False) -> gdal.Dataset:
+                     noData: Optional[float] = None,
+                     v: bool = False) -> gdal.Dataset:
     '''
     Write a numpy array to a GeoTIFF file
     array         : numpy array to write
@@ -1448,7 +1448,7 @@ def copyFile(source:str, destination:str, v:bool = True) -> None:
     if v: print(f'> {source} copied to \t - {destination}')
 
 
-def copyDirectory(source:str, destination:str, recursive = True, v:bool = True, filter = []) -> None:
+def copyDirectory(source:str, destination:str, recursive: bool = True, v:bool = True, filter: list = []) -> None:
     '''
     Copy a directory from source to destination
     source: source directory
@@ -1499,7 +1499,7 @@ def copyFolder(source:str, destination:str, v:bool = True) -> None:
     copyDirectory(source, destination, v=v)
 
 
-def convertCoordinates(lon, lat, srcEPSG, dstCRS) -> tuple:
+def convertCoordinates(lon: float, lat: float, srcEPSG: str, dstCRS: str) -> tuple:
     """
     this function converts coordinates from one CRS to another
     
@@ -1516,7 +1516,7 @@ def convertCoordinates(lon, lat, srcEPSG, dstCRS) -> tuple:
     return (new_lon, new_lat)
 
 
-def extractRasterValue(rasterPath: str, lat: float, lon: float, coordProj: str = 'EPSG:4326') -> float:
+def extractRasterValue(rasterPath: str, lat: float, lon: float, coordProj: str = 'EPSG:4326') -> Optional[float]:
     """
     Extract raster value at given coordinates.
     
@@ -1561,7 +1561,7 @@ def extractRasterValue(rasterPath: str, lat: float, lon: float, coordProj: str =
     return float(value)
 
 
-def getRasterValue(rasterPath: str, lat: float, lon: float, coordProj: str = 'EPSG:4326') -> float:
+def getRasterValue(rasterPath: str, lat: float, lon: float, coordProj: str = 'EPSG:4326') -> Optional[float]:
     '''
     this function is a wrapper for extractRasterValue
     '''
@@ -1588,9 +1588,9 @@ def showProgress(count: int, end: int, message: str, barLength: int = 100) -> No
     percentStr = f'{percent:03.1f}'
     filled = int(barLength * count / end)
     bar = '█' * filled + '░' * (barLength - filled)
-    print(f'\r{bar} {percentStr}% [{count}/{end}] | {message}       ', end='', flush=True)
+    print(f'\r{message} |{bar}| {percent}% [{count}/{end}]', end='', flush=True)
     if count == end:
-        print(f'\r{bar} {percentStr}% [{count}/{end}]                          ', end='', flush=True)
+        print(f'\r{message} |{bar}| {percent}% [{count}/{end}]                          ', end='', flush=True)
         print()
 
 
@@ -1621,7 +1621,7 @@ def dualProgress(primaryCount: int, primaryEnd: int,
         print(f'\r{bar} {formattedPrimaryPercent.rjust(6)}% | {formattedSecondaryPercent.rjust(6)}%                          ', end='', flush=True)
 
 
-def listAllFiles(folder, extension="*"):
+def listAllFiles(folder: str, extension: str = "*") -> list:
     list_of_files = []
     # Getting the current work directory (cwd)
     thisdir = folder
@@ -1643,7 +1643,7 @@ def listAllFiles(folder, extension="*"):
     return list_of_files
 
 
-def clipFeatures(inputFeaturePath:str, boundaryFeature:str, outputFeature:str, keepOnlyTypes = None, v = False) -> geopandas.GeoDataFrame:
+def clipFeatures(inputFeaturePath:str, boundaryFeature:str, outputFeature:str, keepOnlyTypes: Optional[list] = None, v: bool = False) -> geopandas.GeoDataFrame:
     '''
     keepOnlyTypes = ['MultiPolygon', 'Polygon', 'Point', etc]
     
@@ -2023,7 +2023,7 @@ def getTimeseriesStats(data:pandas.DataFrame, observed:Optional[str] = None, sim
 
     return stats
 
-def readSWATPlusOutputs(filePath: str, column: Optional[str] = None, unit: Optional[int] = None, gis_id: Optional[int] = None, name: Optional[str] = None):
+def readSWATPlusOutputs(filePath: str, column: Optional[str] = None, unit: Optional[int] = None, gis_id: Optional[int] = None, name: Optional[str] = None) -> Optional[pandas.DataFrame]:
     '''
     Read SWAT+ output files and return a pandas DataFrame with proper date handling
     and optional filtering capabilities.

{ccfx-1.0.7 → ccfx-1.0.8/ccfx.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ccfx
-Version: 1.0.7
+Version: 1.0.8
 Summary: This package simplifies regular common actions for quick prototyping in a user friendly way
 Author-email: Celray James CHAWANDA <celray@chawanda.com>
 License-Expression: MIT

{ccfx-1.0.7 → ccfx-1.0.8}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ccfx"
-version = "1.0.7"
+version = "1.0.8"
 description = "This package simplifies regular common actions for quick prototyping in a user friendly way"
 readme = "README.md"
 license = "MIT"