Skip to content

Commit ca32efa

Browse files
author
designerror
committed
Updating README.rst
1 parent 80e8c6f commit ca32efa

File tree

1 file changed

+43
-44
lines changed

1 file changed

+43
-44
lines changed

‎README.rst‎

Lines changed: 43 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Installation and upgrade
2828
2929
.. code:: bash
3030
31-
curl https://bootstrap.pypa.io/ez_setup.py -o \-| python
31+
curl https://bootstrap.pypa.io/ez_setup.py -o - | python
3232
python setup.py install --prefix=/opt/setuptools
3333
sudo easy_install webdavclient
3434
@@ -91,107 +91,110 @@ is defined as follows:
9191
}
9292
client = wc.Client(options)
9393
94-
Other options for pycurl
94+
Or you want to limit the speed or turn on verbose mode:
9595

9696
.. code:: python
9797
9898
options = {
99+
...
99100
'recv_speed' : 3000000,
100101
'send_speed' : 3000000,
101-
'verbose' :True
102+
'verbose' : True
102103
}
104+
client = wc.Client(options)
103105
104-
| *recv_speed: rate limit data download speed in Bytes per second. Defaults to unlimited speed.*
105-
| *send_speed: rate limit data upload speed in Bytes per second. Defaults to unlimited speed.*
106-
| *verbose: set verbose mode on/off.*
107-
|
106+
| recv\_speed: rate limit data download speed in Bytes per second.
107+
Defaults to unlimited speed.
108+
| send\_speed: rate limit data upload speed in Bytes per second.
109+
Defaults to unlimited speed.
110+
| verbose: set verbose mode on/off. By default verbose mode is off.
108111
109112
**Synchronous methods**
110113

111114
.. code:: python
112115
113-
//Checking existence of the resource
116+
// Checking existence of the resource
114117
115118
client.check("dir1/file1")
116119
client.check("dir1")
117120
118121
.. code:: python
119122
120-
//Get information about the resource
123+
// Get information about the resource
121124
122125
client.info("dir1/file1")
123126
client.info("dir1/")
124127
125128
.. code:: python
126129
127-
//Check free space
130+
// Check free space
128131
129132
free_size = client.free()
130133
131134
.. code:: python
132135
133-
//Get a list of resources
136+
// Get a list of resources
134137
135138
files1 = client.list()
136139
files2 = client.list("dir1")
137140
138141
.. code:: python
139142
140-
//Create directory
143+
// Create directory
141144
142145
client.mkdir("dir1/dir2")
143146
144147
.. code:: python
145148
146-
//Delete resource
149+
// Delete resource
147150
148151
client.clean("dir1/dir2")
149152
150153
.. code:: python
151154
152-
//Copy resource
155+
// Copy resource
153156
154157
client.copy(remote_path_from="dir1/file1", remote_path_to="dir2/file1")
155158
client.copy(remote_path_from="dir2", remote_path_to="dir3")
156159
157160
.. code:: python
158161
159-
//Move resource
162+
// Move resource
160163
161164
client.move(remote_path_from="dir1/file1", remote_path_to="dir2/file1")
162165
client.move(remote_path_from="dir2", remote_path_to="dir3")
163166
164167
.. code:: python
165168
166-
//Move resource
169+
// Move resource
167170
168171
client.download_sync(remote_path="dir1/file1", local_path="~/Downloads/file1")
169172
client.download_sync(remote_path="dir1/dir2/", local_path="~/Downloads/dir2/")
170173
171174
.. code:: python
172175
173-
//Unload resource
176+
// Unload resource
174177
175178
client.upload_sync(remote_path="dir1/file1", local_path="~/Documents/file1")
176179
client.upload_sync(remote_path="dir1/dir2/", local_path="~/Documents/dir2/")
177180
178181
.. code:: python
179182
180-
//Publish the resource
183+
// Publish the resource
181184
182185
link = client.publish("dir1/file1")
183186
link = client.publish("dir2")
184187
185188
.. code:: python
186189
187-
//Unpublish resource
190+
// Unpublish resource
188191
189192
client.unpublish("dir1/file1")
190193
client.unpublish("dir2")
191194
192195
.. code:: python
193196
194-
//Exception handling
197+
// Exception handling
195198
196199
from webdav.client import WebDavException
197200
try:
@@ -201,21 +204,21 @@ Other options for pycurl
201204
202205
.. code:: python
203206
204-
//Get the missing files
207+
// Get the missing files
205208
206209
client.pull(remote_directory='dir1', local_directory='~/Documents/dir1')
207210
208211
.. code:: python
209212
210-
//Send missing files
213+
// Send missing files
211214
212215
client.push(remote_directory='dir1', local_directory='~/Documents/dir1')
213216
214217
**Asynchronous methods**
215218

216219
.. code:: python
217220
218-
//Load resource
221+
// Load resource
219222
220223
kwargs = {
221224
'remote_path': "dir1/file1",
@@ -233,7 +236,7 @@ Other options for pycurl
233236
234237
.. code:: python
235238
236-
//Unload resource
239+
// Unload resource
237240
238241
kwargs = {
239242
'remote_path': "dir1/file1",
@@ -257,13 +260,13 @@ resources.
257260

258261
.. code:: python
259262
260-
//Get a resource
263+
// Get a resource
261264
262265
res1 = client.resource("dir1/file1")
263266
264267
.. code:: python
265268
266-
//Work with the resource
269+
// Work with the resource
267270
268271
res1.rename("file2")
269272
res1.move("dir1/file2")
@@ -279,14 +282,14 @@ resources.
279282
wdc
280283
===
281284

282-
wdc \-a cross-platform utility that provides convenient work with
285+
wdc - a cross-platform utility that provides convenient work with
283286
WebDAV-servers right from your console. In addition to full
284287
implementations of methods from webdav API, also added methods content
285288
sync local and remote directories.
286289

287290
**Authentication**
288291

289-
\- *Basic authentication*
292+
- *Basic authentication*
290293

291294
.. code:: bash
292295
@@ -297,7 +300,7 @@ sync local and remote directories.
297300
proxy_password: p_password
298301
success
299302
300-
\- Authorize the application using OAuth token\*
303+
- Authorize the application using OAuth token\*
301304

302305
.. code:: bash
303306
@@ -360,17 +363,17 @@ be on the project
360363
+----------------+--------+--------+--------+---------+---------+--------+--------+------------+----------+
361364
| Servers | free | info | list | mkdir | clean | copy | move | download | upload |
362365
+================+========+========+========+=========+=========+========+========+============+==========+
363-
| Yandex.Disk | \+ | \+ | \+ | \+ | \+ | \+ | \+ | \+ | \+ |
366+
| Yandex.Disk | + | + | + | + | + | + | + | + | + |
364367
+----------------+--------+--------+--------+---------+---------+--------+--------+------------+----------+
365-
| Dropbox | \- | \+ | \+ | \+ | \+ | \+ | \+ | \+ | \+ |
368+
| Dropbox | - | + | + | + | + | + | + | + | + |
366369
+----------------+--------+--------+--------+---------+---------+--------+--------+------------+----------+
367-
| Google Drive | \- | \+ | \+ | \+ | \+ | \- | \- | \+ | \+ |
370+
| Google Drive | - | + | + | + | + | - | - | + | + |
368371
+----------------+--------+--------+--------+---------+---------+--------+--------+------------+----------+
369-
| Box | \+ | \+ | \+ | \+ | \+ | \+ | \+ | \+ | \+ |
372+
| Box | + | + | + | + | + | + | + | + | + |
370373
+----------------+--------+--------+--------+---------+---------+--------+--------+------------+----------+
371-
| 4shared | \- | \+ | \+ | \+ | \+ | \- | \- | \+ | \+ |
374+
| 4shared | - | + | + | + | + | - | - | + | + |
372375
+----------------+--------+--------+--------+---------+---------+--------+--------+------------+----------+
373-
| Webdavserver | \- | \+ | \+ | \+ | \+ | \- | \- | \+ | \+ |
376+
| Webdavserver | - | + | + | + | + | - | - | + | + |
374377
+----------------+--------+--------+--------+---------+---------+--------+--------+------------+----------+
375378

376379
Publish and unpublish methods supports only Yandex.Disk.
@@ -390,20 +393,20 @@ A list of settings for WebDAV servers:
390393
hostname: https://webdav.yandex.ru
391394
login: #login_for_yandex
392395
password: #pass_for_yandex
393-
\-dropbox hostname: https://dav.dropdav.com
396+
- dropbox hostname: https://dav.dropdav.com
394397
login: #login_for dropdav
395398
password: #pass_for_dropdav
396-
\-google
399+
- google
397400
hostname: https://dav-pocket.appspot.com
398401
root: docso
399402
login: #login_for_dav-pocket
400403
password: #pass_for_dav-pocket
401-
\-box
404+
- box
402405
hostname: https://dav.box.com
403406
root: dav
404407
login: #login_for_box
405408
password: #pass_for_box
406-
\-4shared
409+
- 4shared
407410
hostname: https://webdav.4shared.com
408411
login: #login_for_4shared
409412
password: #pass_for_4shared
@@ -432,15 +435,11 @@ or locally
432435
#.bashrc
433436
eval "$(register-python-argcomplete wdc)"
434437
435-
Acknowledgments
436-
===============
437-
438-
Thanks to the ``JetBrains`` company for
439-
440438
.. |PyPI version| image:: https://badge.fury.io/py/webdavclient.svg
441439
:target: http://badge.fury.io/py/webdavclient
442440
.. |Requirements Status| image:: https://requires.io/github/designerror/webdav-client-python/requirements.svg?branch=master&style=flat
443441
:target: https://requires.io/github/designerror/webdav-client-python/requirements/?branch=master&style=flat
444442
.. |PullReview stats| image:: https://www.pullreview.com/github/designerror/webdavclient/badges/master.svg?
445443
:target: https://www.pullreview.com/github/designerror/webdavclient/reviews/master
446444
.. |Github| image:: https://github.com/favicon.ico
445+

0 commit comments

Comments
 (0)