Skip to content

Commit a4b4eb9

Browse files
author
Martin Larralde
committed
Update usage and authors list in README.rst
1 parent 52d60cc commit a4b4eb9

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

README.rst

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,24 @@ Supported Python versions
1515
Usage
1616
-----
1717

18+
Use the ``fs.open_fs`` method with the ``webdav://`` protocol:
19+
20+
.. code:: python
21+
22+
>>> import fs
23+
>>> handle = fs.open_fs('webdav://admin:[email protected]:22082/exist/webdav/db')
24+
25+
or use the public constructor of the ``WebDAVFS`` class:
26+
1827
.. code:: python
1928
20-
> from webdavfs.webdavfs import WebDAVFS
21-
> url = 'http://zopyx.com:22082'
22-
> creds = dict(login='admin', password='admin')
23-
> root = '/exist/webdav/db'
24-
> handle = WebDAVFS(url, cred, root)
25-
> handle.makedir('foo')
26-
> print(handle.listdir('.'))
29+
>>> from webdavfs.webdavfs import WebDAVFS
30+
>>> url = 'http://zopyx.com:22082'
31+
>>> creds = dict(login='admin', password='admin')
32+
>>> root = '/exist/webdav/db'
33+
>>> handle = WebDAVFS(url, cred, root)
34+
>>> handle.makedir('foo')
35+
>>> print(handle.listdir('.'))
2736
....
2837
2938
Repository
@@ -47,6 +56,7 @@ Author and contributors
4756
- Yuriy Homyakov
4857
- Semyon Gaivoronskiy
4958
- Andreas Jung
59+
- `Martin Larralde <https://github.com/althonos>`_
5060

5161

5262
License

0 commit comments

Comments
 (0)