.. You should enable this project on travis-ci.org and coveralls.io to make these badges work. The necessary Travis and Coverage config files have been generated for you.
.. image:: https://travis-ci.org/espona/ckanext-composite.svg?branch=master :target: https://travis-ci.org/espona/ckanext-composite
.. image:: https://coveralls.io/repos/espona/ckanext-composite/badge.svg :target: https://coveralls.io/r/espona/ckanext-composite
.. image:: https://img.shields.io/pypi/dm/ckanext-composite.svg :target: https://pypi.python.org/pypi//ckanext-composite/ :alt: Downloads
.. image:: https://img.shields.io/pypi/v/ckanext-composite.svg :target: https://pypi.python.org/pypi/ckanext-composite/ :alt: Latest Version
.. image:: https://img.shields.io/pypi/pyversions/ckanext-composite.svg :target: https://pypi.python.org/pypi/ckanext-composite/ :alt: Supported Python versions
.. image:: https://img.shields.io/pypi/status/ckanext-composite.svg :target: https://pypi.python.org/pypi/ckanext-composite/ :alt: Development Status
.. image:: https://img.shields.io/pypi/l/ckanext-composite.svg :target: https://pypi.python.org/pypi/ckanext-composite/ :alt: License
.. Put a description of your extension here: What does it do? What features does it have? Consider including some screenshots or embedding a video!
Allows to store structured dataset metadata, single or multiple fields. Only one level of subfields is possible. The subfields can be basic text, date type o choice dropboxes. Do not use dashes or numbers in the labels or values of fields.
Supports currently CKAN 2.9. There is a legacy branch for CKAN 2.8 (https://github.com/EnviDat/ckanext-composite/tree/ckan-2.8). Requires the extensions ckanext-scheming and ckanext-repeating (using version from repository eawag-rdm).
.. Add any additional install steps to the list below. For example installing any non-Python dependencies or adding any required config settings.
To install ckanext-composite:
Install the ckan extensions ckanext-scheming and ckanext-composite
Activate your CKAN virtual environment, for example::
. /usr/lib/ckan/default/bin/activate
Install the ckanext-composite Python package into your virtual environment::
pip install ckanext-composite
Add composite
to the ckan.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
Additional config settings::
scheming.presets = ckanext.scheming:presets.json
ckanext.repeating:presets.json
ckanext.composite:presets.json
Add this to your schema.json file::
# Composite Field
{
"field_name": "maintainer",
"label": "Maintainer",
"preset": "composite",
"subfields":[
{
"field_name": "name",
"label": "Name",
"form_placeholder": "Joe Bloggs"
},
{
"field_name": "email",
"label": "Email",
"form_placeholder": "joe@example.com"
},
{
"field_name": "date",
"label": "Date",
"preset": "date",
"form_placeholder": "yyyy-mm-mm"
},
{
"field_name": "identifier_scheme",
"label": "Scheme",
"preset": "select",
"choices": [
{
"value": "orcid",
"label": "ORCID"
},
{
"value": "isni",
"label": "ISNI"
}
]
}
]
}
# Composite Repeating Field
{
"field_name": "author",
"label": "Authors",
"preset": "composite_repeating",
"form_blanks": 1,
"subfields": [
{
"field_name": "name",
"label": "Name",
"form_placeholder":"eg. John Smith"
},
{
"field_name": "type",
"label": "Type",
choices = [
{
"value": "collaborator",
"label": "Collaborator"
},
{
"value": "editor",
"label": "Editor"
}
]
}
]
}
To install ckanext-composite for development, activate your CKAN virtualenv and do::
git clone https://github.com/EnviDat/ckanext-composite.git
cd ckanext-composite
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.composite --cover-inclusive --cover-erase --cover-tests
ckanext-composite should be availabe on PyPI as https://pypi.python.org/pypi/ckanext-composite. 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 in setup.py
is
0.0.1 then do::
git tag 0.0.1 git push --tags
ckanext-composite is availabe on PyPI as https://pypi.python.org/pypi/ckanext-composite. To publish a new version to PyPI follow these steps:
Update the version number in the setup.py
file.
See PEP 440 <http://legacy.python.org/dev/peps/pep-0440/#public-version-identifiers>
_
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 in setup.py
is
0.0.2 then do::
git tag 0.0.2 git push --tags