Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3ead01e
commit 5b07787
Showing
1 changed file
with
30 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1,46 @@ | ||
CouchDB-FUSE | ||
============ | ||
|
||
A FUSE interface to CouchDB. See the [blog post][1] for more details. | ||
|
||
[1]: http://www.jasondavies.com/blog/2008/11/25/edit-couchdb-attachments-directly-with-couchdb-fuse/ | ||
|
||
Requirements | ||
------------ | ||
|
||
* CouchDB-Python version SVN-r125 or greater | ||
* [Python FUSE bindings](http://fuse.sourceforge.net/) | ||
* [CouchDB-Python](http://code.google.com/p/couchdb-python/) 0.5 or greater | ||
|
||
Installation | ||
------------ | ||
|
||
This *should* be as easy as: | ||
Make sure the requirements above are installed, then run `python setup.py | ||
install`. You can also install the latest stable version from [PyPI][2] by | ||
running `easy_install CouchDB-FUSE`. | ||
|
||
easy_install CouchDB-FUSE | ||
[2]: http://pypi.python.org/pypi/CouchDB-FUSE | ||
|
||
Usage | ||
----- | ||
|
||
Currently you can mount a CouchDB document's attachments on a given mount-point | ||
as follows: | ||
$ 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]: http://jchris.mfdz.com/code/2008/11/my_couch_or_yours__shareable_ap | ||
|
||
couchmount http://hostname:port/dbname/doc_id mount-point | ||
Happy Couching! |