Metadata-Version: 2.1
Name: viadot
Version: 0.1.11
Summary: A simple data ingestion library to guide data flows from some places to other places
Home-page: https://github.com/dyvenia/viadot
Author: Alessio Civitillo
License: UNKNOWN
Description: # Viadot
        <p>
        <a href="https://github.com/psf/black" target="_blank">
            <img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Build">
        </a>
        </p>
        A simple data ingestion library to guide data flows from some places to other places
        
        ## Getting Data from a Source
        
        viadot supports few sources. For instance, the UK Carbon Intensity API does not require credentials.
        
        ```python
        from viadot.sources.uk_carbon_intensity import UKCarbonIntensity
        ukci = UKCarbonIntensity()
        ukci.query("/intensity")
        ukci.to_df()
        ```
        
        The above code pulls the UK Carbon Insentity data from the external API to the local Pandas dataframe (df).
        
        ## Loading Data to a Source
        
        TODO
        
        ## Running tests
        ```
        run.sh
        docker exec -it viadot_testing bash
        cd tests/ && pytest .
        ```
        
        ## Running flows locally
        ```
        run.sh
        poetry shell
        FLOW_NAME=supermetrics_to_azure_sql; python -m viadot.flows.$FLOW_NAME
        ```
        
        ## Uploading pkg to PyPi
        
        Generate the `requirements.txt` file from poetry.
        
        ```bash
        poetry export -f requirements.txt --output requirements.txt --with-credentials --dev
        ```
        
        And then publish with poetry.
        
        ```bash
        poetry update
        poetry publish --build
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
