Use right exception.
[jelmer/subvertpy.git] / README.md
1 [![Build Status](https://travis-ci.org/jelmer/subvertpy.png?branch=master)](https://travis-ci.org/jelmer/subvertpy)
2
3 Subvertpy
4 =========
5
6 Homepage: https://jelmer.uk/subvertpy/
7
8 Python bindings for the Subversion version control system that are aimed to be
9 complete, fast and feel native to Python programmers.
10
11 Bindings are provided for the working copy, client, delta, remote access and
12 repository APIs. A hookable server side implementation of the custom Subversion
13 protocol (svn_ra) is also provided.
14
15 Differences with similar packages
16 ---------------------------------
17 subvertpy covers more of the APIs than python-svn. It provides a more
18 "Pythonic" API than python-subversion, which wraps the Subversion C API pretty
19 much directly. Neither provide a hookable server-side.
20
21 Dependencies
22 ------------
23 Subvertpy depends on Python 2.7 or 3.5, and Subversion 1.4 or later. It should
24 work on Windows as well as most POSIX-based platforms (including Linux, BSDs
25 and Mac OS X).
26
27 Installation
28 ------------
29 Standard distutils are used - use "setup.py build" to build and "setup.install"
30 to install. On most platforms, setup will find the Python and Subversion
31 development libraries by itself. On Windows you may have to set various
32 environment variables, see the next section for details.
33
34 Build instructions for Windows
35 ==============================
36
37 * Install the SVN dev kit ZIP for Windows from
38   http://sourceforge.net/projects/win32svn/files/
39   E.g. svn-win32-1.4.6_dev.zip
40 * Find the SVN binary ZIP file with the binaries for your dev kit.
41   E.g. svn-win32-1.4.6.zip
42   Unzip this in the *same directory* as the dev kit - README.txt will be
43   overwritten, but that is all. This is the default location the .ZIP file
44   will suggest (ie, the directory embedded in both .zip files are the same)
45 * Set SVN_DEV to point at this directory.
46 * Install BDB.
47   For Subversion 1.7.0 and later:
48   http://www.oracle.com/technetwork/database/berkeleydb/downloads/index-082944.html
49   download Berkeley DB 4.8.30.msi Windows installer and install it.
50   For Subversion 1.6.17 and earlier:
51   http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=688
52   download "db-4.4.20-win32.zip" or earlier version of BDB and extract it.
53 * Set SVN_BDB to the installed directory or extracted directory.
54 * Install SVN libintl.
55   http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=2627
56   Download svn-win32-libintl.zip.
57   extract it to the directory that you want.
58 * Set SVN_LIBINTL to the extract dir.
59
60 Development
61 -----------
62 If using GCC it might be useful to disable the deprecation warnings when
63 compiling to see if there are any more serious warnings:
64
65 make CFLAGS="-Wno-deprecated-declarations"