rdxz2-utill 1.0.0__tar.gz

rdxz2_utill-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Richard Dharmawan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

rdxz2_utill-1.0.0/PKG-INFO

@@ -0,0 +1,168 @@
+Metadata-Version: 2.4
+Name: rdxz2-utill
+Version: 1.0.0
+Summary: A small example package
+Author-email: Richard Dharmawan <richard.dharmawan@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2024 Richard Dharmawan
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click==8.1.8
+Requires-Dist: duckdb==1.1.3
+Requires-Dist: humanize==4.11.0
+Requires-Dist: loguru==0.7.3
+Requires-Dist: paramiko==3.5.0
+Requires-Dist: pydantic-settings==2.7.1
+Requires-Dist: pydantic==2.10.6
+Requires-Dist: requests==2.32.3
+Requires-Dist: sshtunnel==0.4.0
+Provides-Extra: google-cloud
+Requires-Dist: google-cloud-bigquery==3.29.0; extra == "google-cloud"
+Requires-Dist: google-cloud-storage==3.0.0; extra == "google-cloud"
+Provides-Extra: postgresql
+Requires-Dist: psycopg==3.2.2; extra == "postgresql"
+Provides-Extra: pdf
+Requires-Dist: PyPDF2==3.0.1; extra == "pdf"
+Dynamic: license-file
+
+# Using this library
+
+Installation
+
+```sh
+pip install utill
+```
+
+Usage syntax
+
+```py
+from utill.__MODULE__ import __OBJECT__
+```
+
+Example
+
+```py
+# Using the string module
+from utill.my_string import generate_random_string
+
+print(generate_random_string(16))
+```
+
+## Initial set up
+
+This package contains CLI command
+
+```sh
+utill conf init
+```
+
+# Additional extensions
+
+Syntax
+
+```sh
+pip install utill[__EXTENSION_NAME__]
+```
+
+Extension list:
+
+- google-cloud
+- postgresql
+- pdf
+
+# Per module usages
+
+## my_bq
+
+Executing a query
+
+```py
+from utill.my_bq import BQ
+
+# Initialize BigQuery client
+bq = BQ()
+
+# Execute a query, returns iterable QueryJob
+job = bq.execute_query('...')
+
+# Convert into list for quick data conversion
+results = list(job)
+
+# Iterate the results
+for row in job:
+    # Do anything with the row
+```
+
+Uploading CSV file into BigQuery table
+
+```py
+from utill.my_bq import BQ, Dtype, LoadStrategy
+
+# Initialize BigQuery client
+bq = BQ()
+
+# Load the data
+filename = '/path/to/file.csv'  # Your local CSV file location
+bq_table_fqn = 'project.dataset.table'  # An FQN (fully qualified name) of a BigQuery table to export
+columns = {
+    'col1': Dtype.INT64,
+    'col2': Dtype.STRING,
+    'col3': Dtype.DATE,
+    ...
+}
+partition_col = 'col3'  # Optional, for performance and cost optimization
+cluster_cols = ['col1']  # Optional, for performance and cost optimization
+load_strategy = LoadStrategy.APPEND  # Optional, default to APPEND
+bq.upload_csv(filename, bq_table_fqn, columns, partition_col, cluster_cols, load_strategy)
+```
+
+Exporting query into CSV
+
+```py
+from utill.my_bq import BQ
+
+# Initialize BigQuery client
+bq = BQ()
+
+query = 'SELECT * FROM `project.dataset.table`'  # The query to export
+filename = '/path/to/file.csv'  # Destination CSV file location
+bq.download_csv(query, filename)
+```
+
+Exporting table into XLSX
+
+```py
+from utill.my_bq import BQ
+
+# Initialize BigQuery client
+bq = BQ()
+
+bq_table_fqn = 'project.dataset.table'  # An FQN (fully qualified name) of a BigQuery table to export
+filename = '/path/to/file.xlsx'  # Destination XLSX file location
+bq.download_xlsx(src_table_fqn, dst_filename)
+```

rdxz2_utill-1.0.0/README.md

@@ -0,0 +1,116 @@
+# Using this library
+
+Installation
+
+```sh
+pip install utill
+```
+
+Usage syntax
+
+```py
+from utill.__MODULE__ import __OBJECT__
+```
+
+Example
+
+```py
+# Using the string module
+from utill.my_string import generate_random_string
+
+print(generate_random_string(16))
+```
+
+## Initial set up
+
+This package contains CLI command
+
+```sh
+utill conf init
+```
+
+# Additional extensions
+
+Syntax
+
+```sh
+pip install utill[__EXTENSION_NAME__]
+```
+
+Extension list:
+
+- google-cloud
+- postgresql
+- pdf
+
+# Per module usages
+
+## my_bq
+
+Executing a query
+
+```py
+from utill.my_bq import BQ
+
+# Initialize BigQuery client
+bq = BQ()
+
+# Execute a query, returns iterable QueryJob
+job = bq.execute_query('...')
+
+# Convert into list for quick data conversion
+results = list(job)
+
+# Iterate the results
+for row in job:
+    # Do anything with the row
+```
+
+Uploading CSV file into BigQuery table
+
+```py
+from utill.my_bq import BQ, Dtype, LoadStrategy
+
+# Initialize BigQuery client
+bq = BQ()
+
+# Load the data
+filename = '/path/to/file.csv'  # Your local CSV file location
+bq_table_fqn = 'project.dataset.table'  # An FQN (fully qualified name) of a BigQuery table to export
+columns = {
+    'col1': Dtype.INT64,
+    'col2': Dtype.STRING,
+    'col3': Dtype.DATE,
+    ...
+}
+partition_col = 'col3'  # Optional, for performance and cost optimization
+cluster_cols = ['col1']  # Optional, for performance and cost optimization
+load_strategy = LoadStrategy.APPEND  # Optional, default to APPEND
+bq.upload_csv(filename, bq_table_fqn, columns, partition_col, cluster_cols, load_strategy)
+```
+
+Exporting query into CSV
+
+```py
+from utill.my_bq import BQ
+
+# Initialize BigQuery client
+bq = BQ()
+
+query = 'SELECT * FROM `project.dataset.table`'  # The query to export
+filename = '/path/to/file.csv'  # Destination CSV file location
+bq.download_csv(query, filename)
+```
+
+Exporting table into XLSX
+
+```py
+from utill.my_bq import BQ
+
+# Initialize BigQuery client
+bq = BQ()
+
+bq_table_fqn = 'project.dataset.table'  # An FQN (fully qualified name) of a BigQuery table to export
+filename = '/path/to/file.xlsx'  # Destination XLSX file location
+bq.download_xlsx(src_table_fqn, dst_filename)
+```

rdxz2_utill-1.0.0/pyproject.toml

@@ -0,0 +1,47 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "rdxz2-utill"
+version = "1.0.0"
+authors = [
+  { name="Richard Dharmawan", email="richard.dharmawan@gmail.com" },
+]
+description = "A small example package"
+readme = "README.md"
+requires-python = ">=3.12"
+license = { file = "LICENSE" }
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3 :: Only",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+]
+dependencies = [
+  "click==8.1.8",
+  "duckdb==1.1.3",
+  "humanize==4.11.0",
+  "loguru==0.7.3",
+  "paramiko==3.5.0",
+  "pydantic-settings==2.7.1",
+  "pydantic==2.10.6",
+  "requests==2.32.3",
+  "sshtunnel==0.4.0",
+]
+
+[project.scripts]
+utill = "utill.cmd.utill:main"
+
+[project.optional-dependencies]
+google-cloud = [
+  "google-cloud-bigquery==3.29.0",
+  "google-cloud-storage==3.0.0",
+]
+postgresql = [
+  "psycopg==3.2.2",
+]
+pdf = [
+  "PyPDF2==3.0.1",
+]

rdxz2_utill-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

rdxz2_utill-1.0.0/src/rdxz2_utill.egg-info/PKG-INFO

@@ -0,0 +1,168 @@
+Metadata-Version: 2.4
+Name: rdxz2-utill
+Version: 1.0.0
+Summary: A small example package
+Author-email: Richard Dharmawan <richard.dharmawan@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2024 Richard Dharmawan
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click==8.1.8
+Requires-Dist: duckdb==1.1.3
+Requires-Dist: humanize==4.11.0
+Requires-Dist: loguru==0.7.3
+Requires-Dist: paramiko==3.5.0
+Requires-Dist: pydantic-settings==2.7.1
+Requires-Dist: pydantic==2.10.6
+Requires-Dist: requests==2.32.3
+Requires-Dist: sshtunnel==0.4.0
+Provides-Extra: google-cloud
+Requires-Dist: google-cloud-bigquery==3.29.0; extra == "google-cloud"
+Requires-Dist: google-cloud-storage==3.0.0; extra == "google-cloud"
+Provides-Extra: postgresql
+Requires-Dist: psycopg==3.2.2; extra == "postgresql"
+Provides-Extra: pdf
+Requires-Dist: PyPDF2==3.0.1; extra == "pdf"
+Dynamic: license-file
+
+# Using this library
+
+Installation
+
+```sh
+pip install utill
+```
+
+Usage syntax
+
+```py
+from utill.__MODULE__ import __OBJECT__
+```
+
+Example
+
+```py
+# Using the string module
+from utill.my_string import generate_random_string
+
+print(generate_random_string(16))
+```
+
+## Initial set up
+
+This package contains CLI command
+
+```sh
+utill conf init
+```
+
+# Additional extensions
+
+Syntax
+
+```sh
+pip install utill[__EXTENSION_NAME__]
+```
+
+Extension list:
+
+- google-cloud
+- postgresql
+- pdf
+
+# Per module usages
+
+## my_bq
+
+Executing a query
+
+```py
+from utill.my_bq import BQ
+
+# Initialize BigQuery client
+bq = BQ()
+
+# Execute a query, returns iterable QueryJob
+job = bq.execute_query('...')
+
+# Convert into list for quick data conversion
+results = list(job)
+
+# Iterate the results
+for row in job:
+    # Do anything with the row
+```
+
+Uploading CSV file into BigQuery table
+
+```py
+from utill.my_bq import BQ, Dtype, LoadStrategy
+
+# Initialize BigQuery client
+bq = BQ()
+
+# Load the data
+filename = '/path/to/file.csv'  # Your local CSV file location
+bq_table_fqn = 'project.dataset.table'  # An FQN (fully qualified name) of a BigQuery table to export
+columns = {
+    'col1': Dtype.INT64,
+    'col2': Dtype.STRING,
+    'col3': Dtype.DATE,
+    ...
+}
+partition_col = 'col3'  # Optional, for performance and cost optimization
+cluster_cols = ['col1']  # Optional, for performance and cost optimization
+load_strategy = LoadStrategy.APPEND  # Optional, default to APPEND
+bq.upload_csv(filename, bq_table_fqn, columns, partition_col, cluster_cols, load_strategy)
+```
+
+Exporting query into CSV
+
+```py
+from utill.my_bq import BQ
+
+# Initialize BigQuery client
+bq = BQ()
+
+query = 'SELECT * FROM `project.dataset.table`'  # The query to export
+filename = '/path/to/file.csv'  # Destination CSV file location
+bq.download_csv(query, filename)
+```
+
+Exporting table into XLSX
+
+```py
+from utill.my_bq import BQ
+
+# Initialize BigQuery client
+bq = BQ()
+
+bq_table_fqn = 'project.dataset.table'  # An FQN (fully qualified name) of a BigQuery table to export
+filename = '/path/to/file.xlsx'  # Destination XLSX file location
+bq.download_xlsx(src_table_fqn, dst_filename)
+```

rdxz2_utill-1.0.0/src/rdxz2_utill.egg-info/SOURCES.txt

@@ -0,0 +1,35 @@
+LICENSE
+README.md
+pyproject.toml
+src/rdxz2_utill.egg-info/PKG-INFO
+src/rdxz2_utill.egg-info/SOURCES.txt
+src/rdxz2_utill.egg-info/dependency_links.txt
+src/rdxz2_utill.egg-info/entry_points.txt
+src/rdxz2_utill.egg-info/requires.txt
+src/rdxz2_utill.egg-info/top_level.txt
+src/utill/__init__.py
+src/utill/my_bq.py
+src/utill/my_const.py
+src/utill/my_csv.py
+src/utill/my_datetime.py
+src/utill/my_dict.py
+src/utill/my_encryption.py
+src/utill/my_env.py
+src/utill/my_file.py
+src/utill/my_gcs.py
+src/utill/my_input.py
+src/utill/my_json.py
+src/utill/my_mb.py
+src/utill/my_pg.py
+src/utill/my_queue.py
+src/utill/my_string.py
+src/utill/my_style.py
+src/utill/my_tunnel.py
+src/utill/my_xlsx.py
+src/utill/cmd/__init__.py
+src/utill/cmd/_bq.py
+src/utill/cmd/_conf.py
+src/utill/cmd/_enc.py
+src/utill/cmd/_main.py
+src/utill/cmd/_pg.py
+src/utill/cmd/utill.py

rdxz2_utill-1.0.0/src/rdxz2_utill.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

rdxz2_utill-1.0.0/src/rdxz2_utill.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+utill = utill.cmd.utill:main

rdxz2_utill-1.0.0/src/rdxz2_utill.egg-info/requires.txt

@@ -0,0 +1,19 @@
+click==8.1.8
+duckdb==1.1.3
+humanize==4.11.0
+loguru==0.7.3
+paramiko==3.5.0
+pydantic-settings==2.7.1
+pydantic==2.10.6
+requests==2.32.3
+sshtunnel==0.4.0
+
+[google-cloud]
+google-cloud-bigquery==3.29.0
+google-cloud-storage==3.0.0
+
+[pdf]
+PyPDF2==3.0.1
+
+[postgresql]
+psycopg==3.2.2

rdxz2_utill-1.0.0/src/rdxz2_utill.egg-info/top_level.txt

@@ -0,0 +1 @@
+utill

rdxz2_utill-1.0.0/src/utill/cmd/_bq.py

@@ -0,0 +1,12 @@
+def _upload_csv(src_filename: str, dst_table_fqn: str, cols: list[tuple[str, str]], partition_col: str = None, cluster_cols: list[str] = None, project: str = None):
+    from ..my_bq import BQ
+
+    bq = BQ(project)
+    bq.upload_csv(src_filename, dst_table_fqn, {col: dtype for col, dtype in cols}, partition_col, cluster_cols)
+
+
+def _download_table(src_table_fqn: str, dst_filename: str, project: str):
+    from ..my_bq import BQ
+
+    bq = BQ(project)
+    bq.download_csv(f'SELECT * FROM {src_table_fqn}', dst_filename)

rdxz2_utill-1.0.0/src/utill/cmd/_conf.py

@@ -0,0 +1,62 @@
+def _init(mode: str):
+    from loguru import logger
+
+    from ..my_env import envs, init_pg_file, init_mb_file
+
+    match mode:
+        case 'google-cloud':
+            setattr(envs, 'GCP_PROJECT_ID', input('GCP_PROJECT_ID: '))
+            setattr(envs, 'GCS_BUCKET', input('GCS_BUCKET: '))
+            envs.write()
+            logger.info('Google cloud configuration initialized')
+        case 'postgresql':
+            init_pg_file()
+            logger.info('PostgreSQL connection file initialized')
+        case 'metabase':
+            init_mb_file()
+            logger.info('Metabase connection file initialized')
+        case _:
+            logger.warning(f'Mode \'{mode}\' not recognized')
+
+
+def _list(module: str = None):
+    import json
+    import os
+
+    from loguru import logger
+
+    from ..my_env import envs, PG_FILENAME, MB_FILENAME
+    from ..my_string import mask
+
+    match module:
+        case 'postgresql':
+            if not os.path.exists(PG_FILENAME):
+                logger.error('PostgreSQL configuraiton not exists')
+                return
+
+            config: dict = json.loads(open(PG_FILENAME, 'r').read())
+            for k, v in config.items():
+                print(k)
+                for k2, v2 in v.items():
+                    print(f'\t{k2} = {mask(str(v2)) if k2 in ("password", ) else v2}')
+
+        case 'metabase':
+            if not os.path.exists(MB_FILENAME):
+                logger.error('Metabase configuration not exists')
+                return
+
+            config: dict = json.loads(open(MB_FILENAME, 'r').read())
+            for k, v in config.items():
+                print(f'{k} = {mask(str(v)) if k in ("api_key", ) else v}')
+        case _:
+            for env in envs.model_fields:
+                print(f'{env} = {getattr(envs, env)}')
+
+
+def _set(vars: list[tuple[str, str]]):
+    from ..my_env import envs
+
+    for k, v in vars:
+        setattr(envs, k, v)
+
+    envs.write()

rdxz2_utill-1.0.0/src/utill/cmd/_enc.py

@@ -0,0 +1,26 @@
+def _encrypt(src: str, password: str, output: str = None, force: bool = False):
+    from pathlib import Path
+
+    # Get the password string from file, if exists
+    path_password = Path(password).expanduser()
+    if path_password.exists():
+        if not path_password.is_file():
+            raise ValueError(f'Password path is not a file: {password}')
+        else:
+            password = open(path_password.as_posix(), 'r').read().strip()
+
+    path_src = Path(src).expanduser()
+    if path_src.exists():
+        if path_src.is_dir():
+            raise ValueError(f'Source file is a directory: {src}')
+
+        # Do encryption
+        from ..my_encryption import encrypt_file
+        if output:
+            encrypt_file(path_src.as_posix(), password, dst_filename=output, overwrite=force)
+        else:
+            print(encrypt_file(path_src.as_posix(), password))
+    else:
+        # Do encryption
+        from ..my_encryption import encrypt_string
+        print(encrypt_string(src, password))