Metadata-Version: 2.1
Name: sour-cereal
Version: 1.0.2
Summary: An abstraction of data source for extraction applications usage
Home-page: https://github.com/CarlosAdp/sour-cereal
Author: Carlos Alberto Duarte Pinto
Author-email: carlos.adpinto@gmail.com
License: MIT
Download-URL: https://github.com/CarlosAdp/sour-cereal
Description: # sour-cereal
        
        ## About
        An abstraction of connections to real data sources for extraction applications usage.  
        
        It implements simple methods for extraction preparation, monitoring, execution and cleaning into a class, meant to be inherited.  
        
        The goal of this project consists in creating a standardized API for communicating with data sources in applications written in Python.
        
        ## Installing 
        You can simply install it using *pip* as follows:
        ```console
        $ pip install sour-cereal
        ```
        
        ## Usage
        ```python
        from sour_cereal import SourceConnection
        
        class FooDataSource(SourceConnection):
            def get_status_of_extraction(self: 'FooDataSource', *args, **kwargs):
                return datetime.now()
        
            def check_availability_of_extraction(self: 'FooDataSource', status: datetime):
                return status.hour >= 7		# data is ready only after 7pm
        
            def execute_extraction(self: 'FooDataSource', *args, **kwargs):
        		# Extract some data
                return ['file1', 'file2']
        ```
        
        For more examples, please check the files inside the `sour_cereal/examples` folder.
        
Keywords: abstraction,data extraction,data sources,interface,etl
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Operating System :: OS Independent
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Description-Content-Type: text/markdown
