Skip to content

Commit 2f011c5

Browse files
authored
Update README.md
1 parent 639ee88 commit 2f011c5

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed

README.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -108,88 +108,88 @@ verbose: set verbose mode on/off. By default verbose mode is off.
108108
**Synchronous methods**
109109

110110
```python
111-
// Checking existence of the resource
111+
# Checking existence of the resource
112112

113113
client.check("dir1/file1")
114114
client.check("dir1")
115115
```
116116

117117
```python
118-
// Get information about the resource
118+
# Get information about the resource
119119

120120
client.info("dir1/file1")
121121
client.info("dir1/")
122122
```
123123

124124
```python
125-
// Check free space
125+
# Check free space
126126

127127
free_size = client.free()
128128
```
129129

130130
```python
131-
// Get a list of resources
131+
# Get a list of resources
132132

133133
files1 = client.list()
134134
files2 = client.list("dir1")
135135
```
136136

137137
```python
138-
// Create directory
138+
# Create directory
139139

140140
client.mkdir("dir1/dir2")
141141
```
142142

143143
```python
144-
// Delete resource
144+
# Delete resource
145145

146146
client.clean("dir1/dir2")
147147
```
148148

149149
```python
150-
// Copy resource
150+
# Copy resource
151151

152152
client.copy(remote_path_from="dir1/file1", remote_path_to="dir2/file1")
153153
client.copy(remote_path_from="dir2", remote_path_to="dir3")
154154
```
155155

156156
```python
157-
// Move resource
157+
# Move resource
158158

159159
client.move(remote_path_from="dir1/file1", remote_path_to="dir2/file1")
160160
client.move(remote_path_from="dir2", remote_path_to="dir3")
161161
```
162162

163163
```python
164-
// Move resource
164+
# Move resource
165165

166166
client.download_sync(remote_path="dir1/file1", local_path="~/Downloads/file1")
167167
client.download_sync(remote_path="dir1/dir2/", local_path="~/Downloads/dir2/")
168168
```
169169

170170
```python
171-
// Unload resource
171+
# Unload resource
172172

173173
client.upload_sync(remote_path="dir1/file1", local_path="~/Documents/file1")
174174
client.upload_sync(remote_path="dir1/dir2/", local_path="~/Documents/dir2/")
175175
```
176176

177177
```python
178-
// Publish the resource
178+
# Publish the resource
179179

180180
link = client.publish("dir1/file1")
181181
link = client.publish("dir2")
182182
```
183183

184184
```python
185-
// Unpublish resource
185+
# Unpublish resource
186186

187187
client.unpublish("dir1/file1")
188188
client.unpublish("dir2")
189189
```
190190

191191
```python
192-
// Exception handling
192+
# Exception handling
193193

194194
from webdav.client import WebDavException
195195
try:
@@ -199,21 +199,21 @@ except WebDavException as exception:
199199
```
200200

201201
```python
202-
// Get the missing files
202+
# Get the missing files
203203

204204
client.pull(remote_directory='dir1', local_directory='~/Documents/dir1')
205205
```
206206

207207
```python
208-
// Send missing files
208+
# Send missing files
209209

210210
client.push(remote_directory='dir1', local_directory='~/Documents/dir1')
211211
```
212212

213213
**Asynchronous methods**
214214

215215
```python
216-
// Load resource
216+
# Load resource
217217

218218
kwargs = {
219219
'remote_path': "dir1/file1",
@@ -231,7 +231,7 @@ client.download_async(**kwargs)
231231
```
232232

233233
```python
234-
// Unload resource
234+
# Unload resource
235235

236236
kwargs = {
237237
'remote_path': "dir1/file1",
@@ -254,13 +254,13 @@ Resource API
254254
Resource API using the concept of OOP that enables cloud-level resources.
255255

256256
```python
257-
// Get a resource
257+
# Get a resource
258258

259259
res1 = client.resource("dir1/file1")
260260
```
261261

262262
```python
263-
// Work with the resource
263+
# Work with the resource
264264

265265
res1.rename("file2")
266266
res1.move("dir1/file2")
@@ -361,25 +361,25 @@ A list of settings for WebDAV servers:
361361

362362
```yaml
363363
webdav-servers:
364-
- yandex
364+
- yandex
365365
hostname: https://webdav.yandex.ru
366366
login: #login_for_yandex
367367
password: #pass_for_yandex
368-
- dropbox
368+
- dropbox
369369
hostname: https://dav.dropdav.com
370370
login: #login_for dropdav
371371
password: #pass_for_dropdav
372-
- google
372+
- google
373373
hostname: https://dav-pocket.appspot.com
374374
root: docso
375375
login: #login_for_dav-pocket
376376
password: #pass_for_dav-pocket
377-
- box
377+
- box
378378
hostname: https://dav.box.com
379379
root: dav
380380
login: #login_for_box
381381
password: #pass_for_box
382-
- 4shared
382+
- 4shared
383383
hostname: https://webdav.4shared.com
384384
login: #login_for_4shared
385385
password: #pass_for_4shared

0 commit comments

Comments
 (0)