Metadata-Version: 2.1
Name: fs.dropboxfs
Version: 1.0.0
Summary: Pyfilesystem2 implementation for Dropbox
Home-page: https://github.com/rkhwaja/fs.dropboxfs
License: MIT
Keywords: filesystem,Pyfilesystem2,dropbox
Author: Rehan Khwaja
Author-email: rehan@khwaja.name
Requires-Python: >=3.8
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: dropbox (>=11.36.0)
Requires-Dist: fs (>=2.0.10)
Description-Content-Type: text/markdown

# fs.dropboxfs

Implementation of [pyfilesystem2](https://docs.pyfilesystem.org/) file system using Dropbox

![image](https://github.com/rkhwaja/fs.dropboxfs/workflows/ci/badge.svg) [![PyPI version](https://badge.fury.io/py/fs.dropboxfs.svg)](https://badge.fury.io/py/fs.dropboxfs)

# Usage

``` python
from fs import open_fs
from fs.dropboxfs import DropboxFS

dropboxFS = DropboxFS(
  accessToken=<your access token>,
  refreshToken=<your refresh token>,
  app_key=<your app key>,
  app_secret=<your app secret>)

dropboxFS2 = open_fs('dropbox:///somedirectory?access_token=your_access_token&refresh_token=your_refresh_token')

# dropboxFS and dropboxFS2 are now standard pyfilesystem2 file systems
```

# Development

To run the tests, set the following environment variables:

- DROPBOX_APP_KEY - your app key (see Dropbox Developer Console)
- DROPBOX_APP_SECRET - your app secret (see Dropbox Developer Console)
- DROPBOX_CREDENTIALS_PATH - path to a json file which will contain the credentials

Then generate the credentials json file by running

``` python
./test/generate_credentials.py
```

Then run the tests by executing

```bash
  poe test
```

in the root directory

