Metadata-Version: 2.1
Name: frictionless-dfour
Version: 0.1.0b10
Summary: Dfour Storage for frictionless-py
Home-page: https://github.com/cividi/frictionless-dfour
Author: Thorben Westerhuys
Author-email: thorben@cividi.ch
License: MIT
Description: [![Build](https://img.shields.io/github/workflow/status/cividi/frictionless-dfour/main/main)](https://github.com/cividi/frictionless-dfour/actions)
        [![Coverage](https://img.shields.io/codecov/c/github/cividi/frictionless-dfour/main)](https://codecov.io/gh/cividi/frictionless-dfour)
        [![Registry](https://img.shields.io/pypi/v/frictionless_dfour.svg)](https://pypi.python.org/pypi/frictionless_dfour)
        [![Codebase](https://img.shields.io/badge/github-main-brightgreen)](https://github.com/cividi/frictionless-dfour)
        
        # Frictionless dfour
        
        An extension to add [dfour](https://github.com/cividi/spatial-data-package-platform) storage support in [frictionless-py](https://framework.frictionlessdata.io).
        
        ## Guide
        
        ### Install the package
        
        #### Release version
        
        ```sh
        pip install frictionless_dfour
        ```
        
        #### Dev version
        
        ```sh
        python3 -V # should be > 3.6
        
        # download project
        git clone git@github.com:cividi/frictionless-dfour.git
        cd frictionless-dfour
        
        # Load dynamic dev version
        make dev # or python3 -m pip install -e .
        ```
        
        ## Command Line Usage
        
        ```sh
        export DFOUR_USERNAME=your-dfour-username
        export DFOUR_PASSWORD=your-dfour-password
        dfour workspace dfour-workspace-hash path-to-local-folder-to-sync -e https://sandbox.dfour.space
        ```
        
        ## Python Usage
        
        ### Read from dfour
        
        ```python
        from frictionless import system
        from pprint import pprint
        
        source = "https://sandbox.dfour.space"
        dialect = DfourDialect(snapshotHash="<SNAPSHOT-HASH>", username:"<YOUR-USER>", password: "<YOUR-PASSWORD>")
        
        storage = system.create_storage("dfour", source, dialect=dialect)
        pkg = storage.read_package()
        ```
        
        ### Write to dfour
        
        ```python
        from frictionless import system
        from pprint import pprint
        
        target = "https://sandbox.dfour.space"
        dialect = DfourDialect(workspaceHash:"<WORKSPACE-HASH>", username:"<YOUR-USER>", password: "<YOUR-PASSWORD>")
        
        storage = system.create_storage("dfour", target, dialect=dialect)
        storage.write_package(pkg.to_copy(), force=True)
        ```
Keywords: data validation,frictionless data,open data,json schema,json table schema,data package,tabular data package
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
Provides-Extra: dev
