From 30efaba516a9234976848cbbd469a19df78a6c77 Mon Sep 17 00:00:00 2001 From: Luckydonald Date: Thu, 19 Nov 2015 10:08:16 +0100 Subject: [PATCH] Syntax highlighting in Readme Added proper language reverences to code blocks. --- README.md | 87 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 47 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index 92304a6..3c0ceb7 100644 --- a/README.md +++ b/README.md @@ -14,47 +14,50 @@ Installation ------------ Install using distribute: - - easy_install easywebdav +```shell +easy_install easywebdav +``` Quick Start ----------- - - import easywebdav - # Start off by creating a client object. Username and - # password may be omitted if no authentication is needed. - webdav = easywebdav.connect('webdav.your-domain.com', username='myuser', password='mypass') - # Do some stuff: - webdav.mkdir('some_dir') - webdav.rmdir('another_dir') - webdav.download('remote/path/to/file', 'local/target/file') - webdav.upload('local/path/to/file', 'remote/target/file') +```python +import easywebdav +# Start off by creating a client object. Username and +# password may be omitted if no authentication is needed. +webdav = easywebdav.connect('webdav.your-domain.com', username='myuser', password='mypass') +# Do some stuff: +webdav.mkdir('some_dir') +webdav.rmdir('another_dir') +webdav.download('remote/path/to/file', 'local/target/file') +webdav.upload('local/path/to/file', 'remote/target/file') +``` Client object API ----------------- The API is pretty much self-explanatory: - - cd(path) - ls(path=None) - exists(remote_path) - mkdir(path, safe=False) - mkdirs(path) - rmdir(path, safe=False) - delete(file_path) - upload(local_path_or_fileobj, remote_path) - download(remote_path, local_path_or_fileobj) - +```python +cd(path) +ls(path=None) +exists(remote_path) +mkdir(path, safe=False) +mkdirs(path) +rmdir(path, safe=False) +delete(file_path) +upload(local_path_or_fileobj, remote_path) +download(remote_path, local_path_or_fileobj) +``` Using clientside SSL certificate -------------------------------- - - webdav = easywebdav.connect('secure.example.net', - username='user', - password='pass', - protocol='https', - cert="/path/to/your/certificate.pem") - # Do some stuff: - print webdav.ls() +```python +webdav = easywebdav.connect('secure.example.net', + username='user', + password='pass', + protocol='https', + cert="/path/to/your/certificate.pem") +# Do some stuff: +print webdav.ls() +``` Please note that all options and restriction regarding the "cert" parameter from [Requests API](http://docs.python-requests.org/en/latest/api/) apply here as the parameter is only passed through! @@ -63,20 +66,24 @@ Developing EasyWebDAV --------------------- Working with a virtual environment is highly recommended: - - virtualenv --no-site-packages easywebdav_dev - source easywebdav_dev/bin/activate +```shell +virtualenv --no-site-packages easywebdav_dev +source easywebdav_dev/bin/activate +``` Installing the library in development-mode: - - EASYWEBDAV_DEV=1 python setup.py develop +```shell +EASYWEBDAV_DEV=1 python setup.py develop +``` The first part of the command causes setup.py to install development dependencies, in addition to the normal dependencies. Running the tests: - - nosetests --with-yanc --nologcapture --nocapture tests +```shell +nosetests --with-yanc --nologcapture --nocapture tests +``` Running the tests with WebDAV server logs: - - WEBDAV_LOGS=1 nosetests --with-yanc --nologcapture --nocapture -v tests +```shell +WEBDAV_LOGS=1 nosetests --with-yanc --nologcapture --nocapture -v tests +```