ckanext-metaexport proviedes universal way to export dataset's metadata into different metadata standards.
All formats should be registered before using. In order to do this, perform next steps:
- Implement ckanext.metaexport.interfaces.IMetaexport interface.
- Add register_metadata_format, that returns dictonary with format names as keys and FormatInstances as values.
- Add dataExtractors - method that provides function for generating data, that'll be passed into templates. It can be done via register_data_extractors method, that receives current formatters list and should pick desired format from collection and call set_data_extractor of this format. set_data_extractor expects to receive one argument - function, that will receive package_id and should return dictonary with template variables.
- In order to create your own format, you have to create class, inherited from ckanext.metaexport.formatters.Format
All export views are available under /dataset/{id}/metaexport/{format} URL.
For example, you might want to mention here which versions of CKAN this extension works with.
To install ckanext-metaexport:
Activate your CKAN virtual environment, for example:
. /usr/lib/ckan/default/bin/activate
Install the ckanext-metaexport Python package into your virtual environment:
pip install ckanext-metaexport
- Add
metaexport
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
Document any optional config settings here. For example:
# The minimum number of hours to wait before re-checking a resource
# (optional, default: 24).
ckanext.metaexport.some_setting = some_default_value
To install ckanext-metaexport for development, activate your CKAN virtualenv and do:
git clone https://github.com/DataShades/ckanext-metaexport.git
cd ckanext-metaexport
python setup.py develop
pip install -r dev-requirements.txt
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.metaexport --cover-inclusive --cover-erase --cover-tests
---------------------------------Registering ckanext-metaexport on PyPI ---------------------------------
ckanext-metaexport should be availabe on PyPI as https://pypi.python.org/pypi/ckanext-metaexport. 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-metaexport ----------------------------------------
ckanext-metaexport is availabe on PyPI as https://pypi.python.org/pypi/ckanext-metaexport. 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