Metadata-Version: 2.1
Name: girder_client_mount
Version: 0.3.5.dev4
Summary: Mount a girder server via fuse
Home-page: https://github.com/DigitalSlideArchive/girder-client-mount
Author: Kitware, Inc.
Author-email: kitware@kitware.com
License: Apache Software License 2.0
Keywords: girder,fuse,girder-client
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: cachetools
Requires-Dist: diskcache
Requires-Dist: fusepy
Requires-Dist: girder-client
Requires-Dist: httpio
Requires-Dist: python-dateutil

===================
Girder Client Mount
===================

Mount a Girder server as a local FUSE mount.

Installation
------------

You must have Python >= 3.8 and libfuse installed.

Use pip ::

    pip install girder-client-mount


Example Usage
-------------

Create a mount directory (e.g., ``mkdir /mnt/remote_girder``), then mount it via ::

    girder-client-mount /mnt/remote_girder --username= --password= --apiurl=https://data.kitware.com/api/v1

You can optionally use diskcache to persist data locally.  Add appropriate options (see help for more details) ::

    girder-client-mount /mnt/remote_girder --username= --password= --apiurl=https://data.kitware.com/api/v1 --options diskcache

On Windows, specify an available drive letter for the mount.  You probably will need to also set an environment variable to point to a libfuse compatible dll. ::

    set FUSE_LIBRARY_PATH=c:\Program Files\Dokan\DokanLibrary-1.5.0\dokanfuse1.dll
    girder-client-mount A --username= --password= --apiurl=https://data.kitware.com/api/v1
