annotate sword2-libraries-pyinstaller-compatible/README @ 22:d1752c7031e4
timeouts tip
Updated .hgignore to ignore sword2_logging.conf and anything in .cache
| author |
Steve Welburn <stephen.welburn@eecs.qmul.ac.uk> |
| date |
Tue, 22 Jan 2013 14:43:42 +0000 |
| parents |
8b69bba225c9 |
| children |
|
| rev |
line source |
|
marco@16
|
1 SWORD2 python client
|
|
marco@16
|
2 --------------------
|
|
marco@16
|
3
|
|
marco@16
|
4 A python library and client to connect to and use SWORD v2 compliant servers.
|
|
marco@16
|
5
|
|
marco@16
|
6 SWORD overview
|
|
marco@16
|
7
|
|
marco@16
|
8 SWORD was originally a JISC-funded initiative to define and develop a standard mechanism for depositing into repositories and other systems. Why was it created? because there was no standard way of doing this. A standard deposit interface to repositories allows more services to be built which can offer functionality such as deposit from multiple locations, e.g. disparate repositories, desktop drag’n'drop tools or from within standard office applications. SWORD can also facilitate deposit to multiple repositories, increasingly important for depositors who wish to deposit to funder, institutional or subject repositories. Other possibilities include migration of content between repositories, transfer to preservation services and many more.
|
|
marco@16
|
9
|
|
marco@16
|
10 SWORD is an Atom Publishing Profile
|
|
marco@16
|
11
|
|
marco@16
|
12 Rather than develop a new standard from scratch, SWORD chose to leverage the existing Atom Publishing Protocol (APP), “an application-level protocol for publishing and editing Web resources”. APP is based on the HTTP transfer of Atom-formatted representations yet SWORD has focussed on two key aspects of the protocol – the deposit of files, rather than Atom documents, and the extension mechanism for specifying additional deposit parameters. Also worth noting is that SWORD does not specify the implementation of all of the functionality of APP, rather it supports deposit only – implementations are free to support update and delete if they wish but this is out of the SWORD remit.
|
|
marco@16
|
13
|
|
marco@16
|
14 Python Client library
|
|
marco@16
|
15
|
|
marco@16
|
16 Dependencies
|
|
marco@16
|
17
|
|
marco@16
|
18 The core dependency is httplib2, and uses this for all of its HTTP requests and response handling.
|
|
marco@16
|
19
|
|
marco@16
|
20 The python client tries to use any suitable ElementTree library implementation (lxml, xml.etree, cElementTree, ElementTree) and will fail without one.
|
|
marco@16
|
21
|
|
marco@16
|
22 Installation:
|
|
marco@16
|
23
|
|
marco@16
|
24 python setup.py install
|
|
marco@16
|
25
|
|
marco@16
|
26 (use of a virtualenv is recommended)
|
|
marco@16
|
27
|
|
marco@16
|
28 Software links:
|
|
marco@16
|
29
|
|
marco@16
|
30 Usage documentation: http://bitbucket.org/beno/python-sword2/wiki/Home
|
|
marco@16
|
31
|
|
marco@16
|
32 API documentation: http://packages.python.org/sword2/
|
|
marco@16
|
33
|
|
marco@16
|
34 Repository: http://bitbucket.org/beno/python-sword2
|
|
marco@16
|
35
|
|
marco@16
|
36 Issue-tracker: http://bitbucket.org/beno/python-sword2/issues
|
