Skip to content

Commit

Permalink
Merge branch 'v0.4'
Browse files Browse the repository at this point in the history
  • Loading branch information
mloesch committed May 31, 2015
2 parents 4c59e8b + fefc48b commit 142b162
Show file tree
Hide file tree
Showing 66 changed files with 1,804 additions and 15,804 deletions.
25 changes: 25 additions & 0 deletions .coveragerc
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
[run]
include = sickle*
parallel = True

[report]
# Regexes for lines to exclude from consideration
exclude_lines =
# Have to re-enable the standard pragma
pragma: no cover

# Don't complain about missing debug-only code:
def __repr__
if self\.debug

# Don't complain if tests don't hit defensive assertion code:
raise AssertionError
raise NotImplementedError

# Don't complain if non-runnable code isn't run:
if 0:
if False:
if __name__ == .__main__.:

ignore_errors = True

6 changes: 5 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
doc/_build
docs/_build
*.pyc
build/
dist/
Sickle.egg-info/
sickle.egg-info/
coverage.xml
.coverage*
.idea
5 changes: 5 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
language: python
python:
- "2.7"
install: "pip install ."
script: "nosetests"
9 changes: 9 additions & 0 deletions AUTHORS.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Authors
=======

- Mathias Loesch (original author)

Contributors
------------

- Ben Meier
17 changes: 16 additions & 1 deletion CHANGES.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,22 @@
Changelog
=========


Version 0.4
-----------

May 31, 2015

- bug fix: resumptionToken parameter is exclusive
- added support for harvesting complete OAI-XML responses


Version 0.3
-----------

- added support for protected OAI interfaces (basic auth)
April 17, 2013

- added support for protected OAI interfaces (basic authentication)
- made class mapping for OAI elements configurable
- added options for HTTP timeout and max retries
- added handling of HTTP 503 responses
Expand All @@ -13,10 +25,13 @@ Version 0.3
Version 0.2
-----------

February 26, 2013

- OAI items are now represented as their own classes instead of XML elements
- library raises OAI-specific exceptions
- made lxml a required dependency


Version 0.1
-----------

Expand Down
44 changes: 30 additions & 14 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,23 +1,35 @@
Sickle: An OAI Client Library for Python
========================================
Sickle: OAI-PMH for Humans
==========================

.. image:: https://pypip.in/v/Sickle/badge.png
:target: https://crate.io/packages/Sickle/
:alt: Latest PyPI version

Sickle is lightweight `OAI-PMH <http://www.openarchives.org/OAI/openarchivesprotocol.html>`_
client library written in Python. It has been designed for conveniently retrieving
data from OAI interfaces the Pythonic way::
.. image:: https://pypip.in/d/Sickle/badge.png
:target: https://crate.io/packages/Sickle/
:alt: Number of PyPI downloads

Sickle is a lightweight `OAI-PMH <http://www.openarchives.org/OAI/openarchivesprotocol.html>`_
client library written in Python. It has been designed for conveniently retrieving data from
OAI interfaces the Pythonic way::

>>> from sickle import Sickle
>>> sickle = Sickle('http://elis.da.ulcc.ac.uk/cgi/oai2')
>>> records = sickle.ListRecords(metadataPrefix='oai_dc')

Most importantly, Sickle lets you iterate through OAI records without having to deal
with things like result batches or ``resumptionTokens`` yourself::

>>> records.next()
<Record oai:eprints.rclis.org:4088>

Features
--------

- Easy harvesting of OAI-compliant interfaces
- Support for all six OAI verbs
- Convenient object representations of OAI items (records, headers, sets, ...)
- Automatic dictionary serialization of Dublin Core-encoded metadata payloads
- Option for ignoring deleted items

Installation
============
------------

::

Expand All @@ -29,8 +41,12 @@ Dependencies:
* `lxml <http://lxml.de/>`_


Links
=====
Documentation
-------------

Documentation is available at `Read the Docs <https://sickle.readthedocs.org/en/latest/>`_

Development
-----------

* `Documentation <https://sickle.readthedocs.org/en/latest/>`_
* `Sickle @ GitHub <https://github.com/mloesch/sickle>`_
* `Sickle @ GitHub <https://github.com/mloesch/sickle>`_
179 changes: 0 additions & 179 deletions doc/tutorial.rst

This file was deleted.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading

0 comments on commit 142b162

Please sign in to comment.