ckanext-oaipmh_repository
Requirements
Developed for CKAN 2.8. Depends on ckanext-scheming, ckanext-composite and ckanext-package_converter
Installation
To install ckanext-oaipmh_repository:
Activate your CKAN virtual environment, for example:
. /usr/lib/ckan/default/bin/activate
Install the ckanext-oaipmh_repository Python package into your virtual environment:
pip install ckanext-oaipmh_repository
Add
oaipmh_repository
to theckan.plugins
setting in your CKAN config file (by default the config file is located at/etc/ckan/default/production.ini
).Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu:
sudo service apache2 reload
Config Settings
Document any optional config settings here. For example:
# The minimum number of hours to wait before re-checking a resource # (optional, default: 24). ckanext.oaipmh_repository.some_setting = some_default_value
Development Installation
To install ckanext-oaipmh_repository for development, activate your CKAN virtualenv and do:
git clone https://github.com/espona/ckanext-oaipmh_repository.git cd ckanext-oaipmh_repository python setup.py develop pip install -r requirements.txt
Running the Tests
To run the tests, do:
nosetests --nologcapture --with-pylons=test.ini
To run the tests and produce a coverage report, first make sure you have
coverage installed in your virtualenv (pip install coverage
) then run:
nosetests --nologcapture --with-pylons=test.ini --with-coverage --cover-package=ckanext.oaipmh_repository --cover-inclusive --cover-erase --cover-tests
Registering ckanext-oaipmh_repository on PyPI
ckanext-oaipmh_repository should be availabe on PyPI as https://pypi.python.org/pypi/ckanext-oaipmh_repository. If that link doesn't work, then you can register the project on PyPI for the first time by following these steps:
Create a source distribution of the project:
python setup.py sdist
Register the project:
python setup.py register
Upload the source distribution to PyPI:
python setup.py sdist upload
Tag the first release of the project on GitHub with the version number from the
setup.py
file. For example if the version number insetup.py
is 0.0.1 then do:git tag 0.0.1 git push --tags
Releasing a New Version of ckanext-oaipmh_repository
ckanext-oaipmh_repository is availabe on PyPI as https://pypi.python.org/pypi/ckanext-oaipmh_repository. To publish a new version to PyPI follow these steps:
Update the version number in the
setup.py
file. See PEP 440 for how to choose version numbers.Create a source distribution of the new version:
python setup.py sdist
Upload the source distribution to PyPI:
python setup.py sdist upload
Tag the new release of the project on GitHub with the version number from the
setup.py
file. For example if the version number insetup.py
is 0.0.2 then do:git tag 0.0.2 git push --tags