Metadata-Version: 2.4
Name: CouchDB-FUSE
Version: 0.3
Summary: FUSE interface to CouchDB document attachments.
Author-email: Jason Davies <jason@jasondavies.com>
License-Expression: BSD-3-Clause
Project-URL: Homepage, https://github.com/jasondavies/couchdb-fuse
Project-URL: Repository, https://github.com/jasondavies/couchdb-fuse
Project-URL: Issues, https://github.com/jasondavies/couchdb-fuse/issues
Keywords: couchdb,fuse,filesystem
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Database :: Front-Ends
Classifier: Topic :: System :: Filesystems
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: COPYING
Requires-Dist: CouchDB>=1.0
Requires-Dist: fuse-python>=1.0
Dynamic: license-file

CouchDB-FUSE
============

A FUSE interface to CouchDB.

Requirements
------------

 * A system FUSE implementation such as libfuse or macFUSE
 * Python 3.10 or greater

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

Install it from a checkout with:

    python3 -m pip install .

This also installs the Python dependencies,
[`fuse-python`](https://pypi.org/project/fuse-python/) and
[CouchDB-Python](https://couchdb-python.readthedocs.io/en/latest/).

You can also install the published package from [PyPI][2]:

    python3 -m pip install CouchDB-FUSE

[2]: https://pypi.org/project/CouchDB-FUSE/

Usage
-----

    $ mkdir mnt
    $ couchmount http://localhost:5984/jasondavies/_design%2Flinks mnt/
    $ ls mnt/
    $ touch mnt/foo
    $ ls mnt/
    foo
    $ 

Use cases
---------

 * If you've read [My Couch or Yours? Shareable Apps Are The Future][3] by
   jchris, this is a great time-saver if you want to edit HTML, JavaScript, CSS
   or even image files directly using your favourite editor.
 * Uploading large numbers of files repetitively through Futon or even via a
   Python prompt becomes tedious very quickly: drag'n'drop or `cp *` is the way
   forward!

[3]: https://web.archive.org/web/20090107050156/http://jchris.mfdz.com/code/2008/11/my_couch_or_yours__shareable_ap

Happy Couching!
