TODO: PDZInfo tested
[libisds.git] / README
blobb5f4939f242083102631c2c404fd8e59dba5fc3c
1 This is client library for accessing SOAP services of ISDS (Informační systém
2 datových schránek / Data Box Information System) as defined in Czech ISDS Act
3 (300/2008 Coll.) <http://portal.gov.cz/zakon/300/2008> and implied documents.
5 Copyright (C) 2009, 2010, 2011  Petr Písař <petr.pisar@atlas.cz>
7 This program is free software: you can redistribute it and/or modify it under
8 the terms of the GNU Lesser General Public License as published by the Free
9 Software Foundation, either version 3 of the License, or (at your option) any
10 later version.
12 This program is distributed in the hope that it will be useful, but WITHOUT
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
14 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
15 details.
18 This code is written in ISO99 C language and requires libxml2, (optional but
19 strongly recommended) cURL, libgcrypt, GPGME, and >=expat-2.0.0 libraries at
20 compilation time. gnupg2 is required at run time (provides gpgsm that uses
21 gpgme to process CMS).  Build system preparation from VCS requies
22 >=automake-1.11, autoconf and libtool in addition.
24 Applications linked against this library need to be linked to libxml2 too.
26 It has been tested on GNU/Linux (Linux 2.6.36, glibc-2.12.2, gcc-4.5.2) with
27 libxml2-2.7.8, curl-7.21.4, libgcrypt-1.4.6, gpgme-1.3.0, expat-2.0.1 and
28 gnupg-2.0.17 on n32 MIPS64 architecture.
30 Latest code can be obtained from GIT repository
31 <http://repo.or.cz/w/libisds.git> (web interface).
33 ISDS documentation is located under `doc' directory, user documentation can be
34 found in header files. See `client' directory for examples how to use this
35 library. Preliminary library self-tests are located in `test' directory. Test
36 data and message examples are stored in `server/messages' directory.
38 Credentials for testing account can be passed to example clients and on-line
39 tests by environmental variables `ISDS_USERNAME' and `ISDS_PASSWORD' or by
40 saving them into `testing_credentials' in build root directory (first line is
41 user name, second line is password). Environmental variables take precedence.