From 0e9c5a9130d7f73bc2a70b0b13bdb170d86e4758 Mon Sep 17 00:00:00 2001 From: Markus Unterwaditzer Date: Sat, 1 Mar 2014 20:39:59 +0100 Subject: [PATCH] Add test suite instructions --- .gitignore | 2 ++ README.md | 8 +++++++- dev_requirements.txt | 3 +++ setup.py | 2 +- 4 files changed, 13 insertions(+), 2 deletions(-) create mode 100644 dev_requirements.txt diff --git a/.gitignore b/.gitignore index 95530ea..dbb3ea0 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,5 @@ __pycache__ htmlcov .coverage +build +env diff --git a/README.md b/README.md index bc51467..d78e2b4 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,16 @@ This is work-in-progress. A basic syncronization utility for [vdir](https://github.com/untitaker/vdir). Should be able to sync both CardDAV and CalDAV in the end. -## How to run +## How to use Copy `config.example` to `~/.vdirsyncer/config` and edit it. You can use the `VDIRSYNCER_CONFIG` environment variable to change the path vdirsyncer will read the config from. Run `vdirsyncer --help`. + +## How to run the tests + + pip install . + pip install -r dev_requirements.txt + py.test diff --git a/dev_requirements.txt b/dev_requirements.txt new file mode 100644 index 0000000..b0f903a --- /dev/null +++ b/dev_requirements.txt @@ -0,0 +1,3 @@ +Radicale +Werkzeug +pytest diff --git a/setup.py b/setup.py index c952670..3db17bb 100644 --- a/setup.py +++ b/setup.py @@ -25,5 +25,5 @@ setup( entry_points={ 'console_scripts': ['vdirsyncer = vdirsyncer.cli:main'] }, - install_requires=['argvard', 'requests'] + install_requires=['argvard', 'requests', 'lxml'] )