Merge pull request #34 from lnyemba/v2.2.0

V2.2.0

README.md

@@ -4,34 +4,40 @@ This project implements an abstraction of objects that can have access to a vari
 
 # Why Use Data-Transport ?
 
-Mostly data scientists that don't really care about the underlying database and would like a simple and consistent way to read/write and move data are well served. Additionally we implemented lightweight Extract Transform Loading API and command line (CLI) tool. Finally it is possible to add pre/post processing pipeline functions to read/write
-
-1. Familiarity with **pandas data-frames**
-2. Connectivity **drivers** are included
-3. Reading/Writing data from various sources
-4. Useful for data migrations or **ETL**
+Data transport is a simple framework that enables read/write to multiple databases or technologies that can hold data. In using **data-transport**, you are able to:
 
+- Enjoy the simplicity of **data-transport** because it leverages SQLAlchemy & Pandas data-frames.
+- Share notebooks and code without having to disclosing database credentials. 
+- Seamlessly and consistently access to multiple database technologies at no cost
+- No need to worry about accidental writes to a database leading to inconsistent data
+- Implement consistent pre and post processing as a pipeline i.e aggregation of functions
+- **data-transport** is open-source under MIT License https://github.com/lnyemba/data-transport
 
 ## Installation
 
-Within the virtual environment perform the following :
+Within the virtual environment perform the following, the options for installation are:
 
-    pip install git+https://github.com/lnyemba/data-transport.git
+**sql**       - by default postgresql, mysql, sqlserver, sqlite3+, duckdb 
 
-## Features
+    pip install data-transport[cloud,nosql,other,all]git+https://github.com/lnyemba/data-transport.git
 
-    - read/write from over a dozen databases
-    - run ETL jobs seamlessly
-    - scales and integrates into shared environments like apache zeppelin; jupyterhub; SageMaker; ...
+Options to install components in square brackets, these components are 
+
+**warehouse** - Apache Iceberg, Apache Drill
 
-## What's new
+**cloud**  - to support nextcloud, s3
 
-Unlike older versions 2.0 and under, we focus on collaborative environments like jupyter-x servers; apache zeppelin:
+**nosql** - support for mongodb, couchdb
 
-    1. Simpler syntax to create reader or writer
-    2. auth-file registry that can be referenced using a label
-    3. duckdb support
+**other**  - support for files, rabbitmq, http
 
+    pip install data-transport[nosql,cloud,warehouse,all]@git+https://github.com/lnyemba/data-transport.git
+
+## Additional features
+
+    - In addition to read/write, there is support for functions for pre/post processing
+    - CLI interface to add to registry, run ETL
+    - scales and integrates into shared environments like apache zeppelin; jupyterhub; SageMaker; ...
 
 ## Learn More
 

bin/transport

@@ -178,7 +178,17 @@ def register (label:Annotated[str,typer.Argument(help="unique label that will be
         _msg = f"""{TIMES_MARK} {e}"""
     print (_msg)
     
-    pass
+@app_r.command(name="list")
+def register_list ():
+    """
+    This function will list existing registry entries and basic information {label,vendor}
+    """
+    # print (transport.registry.DATA)
+    _reg = transport.registry.DATA
+    _data = [{'label':key,'provider':_reg[key]['provider']} for key in _reg if 'provider' in _reg[key]]
+    _data = pd.DataFrame(_data)
+    print (_data)
+
 @app_x.command(name='add') 
 def register_plugs (
     alias:Annotated[str,typer.Argument(help="unique function name within a file")],

bin/transport.cmd

@@ -0,0 +1,2 @@
+cd /D "%~dp0"
+python transport %1 %2 %3 %4 %5 %6

pyproject.toml

@@ -39,16 +39,11 @@ Homepage = "https://healthcareio.the-phi.com/git/code/transport.git"
 [tool.setuptools]
 include-package-data = true
 zip-safe = false
-script-files = ["bin/transport"]
+script-files = ["bin/transport","bin/transport.cmd"]
 
 [tool.setuptools.packages.find]
-include = ["info","info.*", "transport", "transport.*"]
+include = [ "transport", "transport.*"]
 
 [tool.setuptools.dynamic]
-version = {attr = "info.__version__"}
+version = {attr = "transport.info.__version__"}
 #authors = {attr = "info.__author__"}
-
-# If you have a info.py file, you might also want to include the author dynamically:
-# [tool.setuptools.dynamic]
-# version = {attr = "info.__version__"}
-# authors = {attr = "info.__author__"}

transport/__init__.py

@@ -42,7 +42,7 @@ except Exception as e:
 import pandas as pd
 import json
 import os
-from info import __version__,__author__,__email__,__license__,__app_name__,__whatsnew__,__edition__
+from transport.info import __version__,__author__,__email__,__license__,__app_name__,__whatsnew__,__edition__
 from transport.iowrapper import IWriter, IReader, IETL
 from transport.plugins import PluginLoader
 from transport import providers

transport/info.py

@@ -0,0 +1,23 @@
+__app_name__  = 'data-transport'
+__author__ = 'The Phi Technology'
+__version__= '2.2.30'
+__email__  = "info@the-phi.com"
+__edition__= 'community'
+__license__=f"""
+Copyright 2010 - 2024, Steve L. Nyemba
+
+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.
+
+"""
+
+__whatsnew__=f"""version {__version__}, 
+1. Added support for read/write logs as well as plugins (when applied)
+2. Bug fix with duckdb (adding readonly) for readers because there are issues with threads & processes
+3. support for streaming data, important to use this with large volumes of data
+
+
+"""

transport/other/files.py

@@ -30,7 +30,11 @@ class Reader (File):
 	def read(self,**args):
 		_path = self.path if 'path' not in args else args['path']
 		_delimiter = self.delimiter if 'delimiter' not in args else args['delimiter']
-		return pd.read_csv(_path,delimiter=self.delimiter)
+		_df =  pd.read_csv(_path,delimiter=self.delimiter)
+		if 'query' in args :
+			_query = args['query']
+			_df = _df.query(_query)
+		return _df
 	def stream(self,**args):
 		raise Exception ("streaming needs to be implemented")
 class Writer (File):

transport/registry.py

@@ -1,6 +1,6 @@
 import os
 import json
-from info import __version__
+from transport.info import __version__
 import copy
 import transport
 import importlib