Metadata-Version: 2.1
Name: fs.onedatarestfs
Version: 21.2.5.1
Summary: Onedata REST-based filesystem for PyFilesystem
Home-page: https://github.com/onedata/onedatarestfs
Author: Bartek Kryza
Author-email: bkryza@gmail.com
License: MIT
Description: # OnedataRESTFS
        
        OnedataRESTFS is a [PyFilesystem](https://www.pyfilesystem.org/) interface to
        [Onedata](https://onedata.org) virtual file system based on [Onedata REST API].
        
        As a PyFilesystem concrete class, [OnedataRESTFS](https://github.com/onedata/onedatarestfs/)
        allows you to work with Onedata in the same way as any other supported filesystem.
        
        ## Installing
        
        You can install OnedataRESTFS from pip as follows:
        
        ```
        pip install fs.onedatarestfs
        ```
        
        ## Opening a OnedataRESTFS
        
        Open an OnedataRESTFS by explicitly using the constructor:
        
        ```python
        from fs.onedatarestfs import OnedataRESTFS
        onedata_onezone_host = "..."
        onedata_access_token = "..."
        odfs = OnedataRESTFS(onedata_onezone_host, onedata_access_token)
        ```
        
        Or with a FS URL:
        
        ```python
          from fs import open_fs
          odfs = open_fs('onedatarestfs://HOST?token=...')
        ```
        
        
        ## Building and running tests
        
        ```bash
        virtualenv -p /usr/bin/python3 venv
        . venv/bin/activate
        
        # Install tox
        pip install coverage tox
        
        # Run flake8 check
        tox -c tox.ini -e flake8
        
        # Run mypy typing check
        tox -c tox.ini -e mypy
        
        # Run PyFilesystem test suite
        tox -c tox.ini -e fstest
        ```
        
        ## Documentation
        
        - [PyFilesystem Wiki](https://www.pyfilesystem.org)
        - [OnedataRESTFS Reference](http://onedatarestfs.readthedocs.io/en/latest/)
        - [Onedata Homepage](https://onedata.org)
Keywords: pyfilesystem,Onedata
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: System :: Filesystems
Description-Content-Type: text/markdown
