Merge branch 'release/2.0.0'

.gitignore

@@ -1,22 +1,222 @@
-# Eclipse project
-.project
+
+# Created by https://www.gitignore.io/api/pydev,python,pycharm,eclipse
+
+### Eclipse ###
+
+.metadata
+bin/
+tmp/
+*.tmp
+*.bak
+*.swp
+*~.nib
+local.properties
+.settings/
+.loadpath
+.recommenders
+
+# External tool builders
+.externalToolBuilders/
+
+# Locally stored "Eclipse launch configurations"
+*.launch
+
+# PyDev specific (Python IDE for Eclipse)
+*.pydevproject
+
+# CDT-specific (C/C++ Development Tooling)
+.cproject
+
+# Java annotation processor (APT)
+.factorypath
+
+# PDT-specific (PHP Development Tools)
+.buildpath
+
+# sbteclipse plugin
+.target
+
+# Tern plugin
+.tern-project
+
+# TeXlipse plugin
+.texlipse
+
+# STS (Spring Tool Suite)
+.springBeans
+
+# Code Recommenders
+.recommenders/
+
+# Scala IDE specific (Scala & Java development for Eclipse)
+.cache-main
+.scala_dependencies
+.worksheet
+
+### PyCharm ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff:
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/dictionaries
+
+# Sensitive or high-churn files:
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.xml
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+
+# Gradle:
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# CMake
+cmake-build-debug/
+
+# Mongo Explorer plugin:
+.idea/**/mongoSettings.xml
+
+## File-based project format:
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+/out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+### PyCharm Patch ###
+# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
+
+# *.iml
+# modules.xml
+# .idea/misc.xml
+# *.ipr
+
+# Sonarlint plugin
+.idea/sonarlint
+
+### pydev ###
 .pydevproject
-org.eclipse.*
 
-# Python compiled/optimized files
-*.py[co]
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
 
-# Python packaging/distribution
-*.egg
-*.egg-info
-dist
-build
-eggs
-parts
-bin
-var
-sdist
-develop-eggs
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
 .installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+ENV/
+env/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
 
+# mkdocs documentation
+/site
 
+# End of https://www.gitignore.io/api/pydev,python,pycharm,eclipse

.travis.yml

@@ -0,0 +1,9 @@
+language: python
+python:
+  - "2.6"
+  - "2.7"
+  - "3.4"
+  - "3.5"
+  - "3.6"
+install: "pip install tox-travis"
+script: "tox"

CHANGES.rst

@@ -1,6 +1,36 @@
 CHANGES
 =======
 
+2.0.0 Wednesday 19th April 2017
+-------------------------------
+
+NEW FEATURES
+~~~~~~~~~~~~
+
+- Support for building a development virtualenv and testing builds using Tox_
+
+- Integration with `Travis CI`_
+
+
+ENHANCEMENTS
+~~~~~~~~~~~~
+
+- Now works in Python 3 (thanks to `@ulikoehler <https://github.com/ulikoehler>`_)
+
+- Allow providers with https transport scheme (thanks to
+  `@ulikoehler <https://github.com/ulikoehler>`_)
+
+
+1.2.0 Friday 30th December 2016
+-------------------------------
+
+BUG FIXES
+~~~~~~~~~
+
+- Fix build by using ``ez_setup.py`` instead of ``distribute_setup.py`` for
+  bootstrapping setuptools.
+
+
 1.1.5 Monday 28th April 2014
 ----------------------------
 
@@ -97,7 +127,11 @@ NEW FEATURES
     directory - for regular harvesting from a named provider
 
   - Specify provider using registered name when harvesting, or harvest
-    from all registered providers using the reserved name `all`
+    from all registered providers using the reserved name ``all``
 
   - Harvest only records modified since last harvest (unless overridden)
 
+
+.. Links
+.. _Travis CI: https://travis-ci.org/
+.. _Tox: https://tox.readthedocs.io/en/latest/

README.rst

@@ -1,7 +1,17 @@
 OAI-PMH Harvest
 ===============
 
-28th April 2014 (2014-04-28)
+.. image:: https://travis-ci.org/bloomonkey/oai-harvest.svg?branch=master
+   :target: https://travis-ci.org/bloomonkey/oai-harvest
+
+.. image:: https://img.shields.io/pypi/v/oaiharvest.svg
+   :target: https://pypi.python.org/pypi/oaiharvest
+   :alt: Latest Version
+
+.. image:: https://img.shields.io/pypi/l/oaiharvest.svg
+   :target: LICENSE.rst
+   :alt: license:BSD
+
 
 Contents
 --------
@@ -54,14 +64,9 @@ The latest release version is available in the Python Packages Index:
 
 https://pypi.python.org/pypi/oaiharvest
 
-.. image:: https://pypip.in/v/oaiharvest/badge.png
-    :target: https://crate.io/packages/oaiharvest/
-    :alt: Latest PyPI version
-
-.. image:: https://pypip.in/d/oaiharvest/badge.png
-    :target: https://crate.io/packages/oaiharvest/
-    :alt: Number of PyPI downloads
-
+.. image:: https://img.shields.io/pypi/v/oaiharvest.svg
+   :target: https://pypi.python.org/pypi/oaiharvest
+   :alt: Latest PyPI Version
 
 
 Source code is under version control and available from:
@@ -82,11 +87,17 @@ in this README file!
 Requirements / Dependencies
 ---------------------------
 
-- Python_ >= 2.6
+- Python_ >= 2.6 or Python 3.x
 - pyoai_
 - lxml_
 - sqlite3_
 
+Note that Python 3.x support requires pyoai 2.4.6+.
+
+As this release is not yet available on PyPI, use
+``pip3 install git+https://github.com/infrae/pyoai.git``
+
+Python3 support is still in beta and might have some bugs.
 
 Installation
 ------------
@@ -110,13 +121,20 @@ there.
 
        git clone git@github.com:<username>/oai-harvest.git
 
-3. Install dependencies::
+3. Setup development virtualenv using tox::
+
+       pip install tox
+       tox -e dev
+
+4. Activate development virtualenv:
 
-       pip install -r requirements.txt
+   -nix::
 
-4. Install in develop / editable mode::
+       source env/bin/activate
 
-       pip install -e .
+   Windows::
+
+       env\Scripts\activate
 
 
 Bugs, Feature requests etc.
@@ -133,6 +151,11 @@ or submit a pull request on GitHub.
 Copyright And Licensing
 -----------------------
 
+
+.. image:: https://img.shields.io/pypi/l/oaiharvest.svg
+   :target: LICENSE.rst
+   :alt: license:BSD
+
 Copyright (c) `University of Liverpool`_, 2013-2014
 
 See `LICENSE.rst <LICENSE.rst>`_ for licensing details.