{ "info": { "author": "Lucia Espona", "author_email": "lucia.espona@wsl.ch", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7" ], "description": ".. You should enable this project on travis-ci.org and coveralls.io to make\n these badges work. The necessary Travis and Coverage config files have been\n generated for you.\n\n.. image:: https://travis-ci.org/espona/ckanext-composite.svg?branch=master\n :target: https://travis-ci.org/espona/ckanext-composite\n \n.. image:: https://coveralls.io/repos/espona/ckanext-composite/badge.svg\n :target: https://coveralls.io/r/espona/ckanext-composite\n\n.. image:: https://pypip.in/download/ckanext-composite/badge.svg\n :target: https://pypi.python.org/pypi//ckanext-composite/\n :alt: Downloads\n\n.. image:: https://pypip.in/version/ckanext-composite/badge.svg\n :target: https://pypi.python.org/pypi/ckanext-composite/\n :alt: Latest Version\n\n.. image:: https://pypip.in/py_versions/ckanext-composite/badge.svg\n :target: https://pypi.python.org/pypi/ckanext-composite/\n :alt: Supported Python versions\n\n.. image:: https://pypip.in/status/ckanext-composite/badge.svg\n :target: https://pypi.python.org/pypi/ckanext-composite/\n :alt: Development Status\n\n.. image:: https://pypip.in/license/ckanext-composite/badge.svg\n :target: https://pypi.python.org/pypi/ckanext-composite/\n :alt: License\n\n=============\nckanext-composite\n=============\n\n.. Put a description of your extension here:\n What does it do? What features does it have?\n Consider including some screenshots or embedding a video!\n \nAllows 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.\n\n\n------------\nRequirements\n------------\n\nDeveloped for CKAn version 2.5.2. Requires the extensions ckanext-scheming and ckanext-repeating (using version from repository eawag-rdm).\n\n------------\nInstallation\n------------\n\n.. Add any additional install steps to the list below.\n For example installing any non-Python dependencies or adding any required\n config settings.\n\nTo install ckanext-composite:\n\n0. Install the ckan extensions ckanext-scheming and ckanext-composite\n\n1. Activate your CKAN virtual environment, for example::\n\n . /usr/lib/ckan/default/bin/activate\n\n2. Install the ckanext-composite Python package into your virtual environment::\n\n pip install ckanext-composite\n\n3. Add ``composite`` to the ``ckan.plugins`` setting in your CKAN\n config file (by default the config file is located at\n ``/etc/ckan/default/production.ini``).\n\n4. Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu::\n\n sudo service apache2 reload\n\n\n---------------\nConfig Settings\n---------------\n\nAdditional config settings::\n\n scheming.presets = ckanext.scheming:presets.json\n ckanext.repeating:presets.json\n ckanext.composite:presets.json\n\nAdd this to your schema.json file::\n\n # Composite Field\n {\n \"field_name\": \"maintainer\",\n \"label\": \"Maintainer\",\n \"preset\": \"composite\",\n \"subfields\":[\n {\n \"field_name\": \"name\",\n \"label\": \"Name\",\n \"form_placeholder\": \"Joe Bloggs\"\n },\n {\n \"field_name\": \"email\",\n \"label\": \"Email\",\n \"form_placeholder\": \"joe@example.com\"\n },\n {\n \"field_name\": \"date\",\n \"label\": \"Date\",\n \"preset\": \"date\",\n \"form_placeholder\": \"yyyy-mm-mm\"\n },\n {\n \"field_name\": \"identifier_scheme\",\n \"label\": \"Scheme\",\n \"preset\": \"select\",\n \"choices\": [\n {\n \"value\": \"orcid\",\n \"label\": \"ORCID\"\n },\n {\n \"value\": \"isni\",\n \"label\": \"ISNI\"\n }\n ]\n }\n ]\n }\n # Composite Repeating Field\n {\n \"field_name\": \"author\",\n \"label\": \"Authors\",\n \"preset\": \"composite_repeating\",\n \"form_blanks\": 1,\n \"subfields\": [\n {\n \"field_name\": \"name\",\n \"label\": \"Name\",\n \"form_placeholder\":\"eg. John Smith\"\n },\n {\n \"field_name\": \"type\",\n \"label\": \"Type\",\n choices = [\n {\n \"value\": \"collaborator\",\n \"label\": \"Collaborator\"\n },\n {\n \"value\": \"editor\",\n \"label\": \"Editor\"\n }\n ]\n }\n ]\n }\n \n------------------------\nDevelopment Installation\n------------------------\n\nTo install ckanext-composite for development, activate your CKAN virtualenv and\ndo::\n\n git clone https://github.com/espona/ckanext-composite.git\n cd ckanext-composite\n python setup.py develop\n pip install -r dev-requirements.txt\n\n\n-----------------\nRunning the Tests\n-----------------\n\nTo run the tests, do::\n\n nosetests --nologcapture --with-pylons=test.ini\n\nTo run the tests and produce a coverage report, first make sure you have\ncoverage installed in your virtualenv (``pip install coverage``) then run::\n\n nosetests --nologcapture --with-pylons=test.ini --with-coverage --cover-package=ckanext.composite --cover-inclusive --cover-erase --cover-tests\n\n\n---------------------------------\nRegistering ckanext-composite on PyPI\n---------------------------------\n\nckanext-composite should be availabe on PyPI as\nhttps://pypi.python.org/pypi/ckanext-composite. If that link doesn't work, then\nyou can register the project on PyPI for the first time by following these\nsteps:\n\n1. Create a source distribution of the project::\n\n python setup.py sdist\n\n2. Register the project::\n\n python setup.py register\n\n3. Upload the source distribution to PyPI::\n\n python setup.py sdist upload\n\n4. Tag the first release of the project on GitHub with the version number from\n the ``setup.py`` file. For example if the version number in ``setup.py`` is\n 0.0.1 then do::\n\n git tag 0.0.1\n git push --tags\n\n\n----------------------------------------\nReleasing a New Version of ckanext-composite\n----------------------------------------\n\nckanext-composite is availabe on PyPI as https://pypi.python.org/pypi/ckanext-composite.\nTo publish a new version to PyPI follow these steps:\n\n1. Update the version number in the ``setup.py`` file.\n See `PEP 440 `_\n for how to choose version numbers.\n\n2. Create a source distribution of the new version::\n\n python setup.py sdist\n\n3. Upload the source distribution to PyPI::\n\n python setup.py sdist upload\n\n4. Tag the new release of the project on GitHub with the version number from\n the ``setup.py`` file. For example if the version number in ``setup.py`` is\n 0.0.2 then do::\n\n git tag 0.0.2\n git push --tags", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/espona/ckanext-composite", "keywords": "CKAN scheming composite", "license": "AGPL", "maintainer": null, "maintainer_email": null, "name": "ckanext-composite", "package_url": "https://pypi.org/project/ckanext-composite/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/ckanext-composite/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/espona/ckanext-composite" }, "release_url": "https://pypi.org/project/ckanext-composite/0.0.2/", "requires_dist": null, "requires_python": null, "summary": "\"Structured metadata extension for CKAN\"", "version": "0.0.2" }, "last_serial": 2815452, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "9e16e630f95463bf6cdab813cd1cb5bc", "sha256": "faaad598950c1e3df599c99318178de1bb90abf2bf54614c2f7f5b3a0a0d67bc" }, "downloads": -1, "filename": "ckanext-composite-0.0.1.tar.gz", "has_sig": false, "md5_digest": "9e16e630f95463bf6cdab813cd1cb5bc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12402, "upload_time": "2017-04-07T13:12:14", "url": "https://files.pythonhosted.org/packages/0c/46/d880ed97c0578b8cabd0649cfcbccb9fb46fa7840533210c3ea30e6159a5/ckanext-composite-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "eb2c09a2330cd4df028617eb2e545101", "sha256": "dcbc6a822cc3e8fb1f957f3fdd93c2dde71bba6f5e66c3b2c401789c95ff9d1b" }, "downloads": -1, "filename": "ckanext-composite-0.0.2.tar.gz", "has_sig": false, "md5_digest": "eb2c09a2330cd4df028617eb2e545101", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12389, "upload_time": "2017-04-19T22:27:56", "url": "https://files.pythonhosted.org/packages/af/87/8770d34cb052396a3629ce65c8d5a08dd686f672e59a8e64bcb4c6cb0154/ckanext-composite-0.0.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "eb2c09a2330cd4df028617eb2e545101", "sha256": "dcbc6a822cc3e8fb1f957f3fdd93c2dde71bba6f5e66c3b2c401789c95ff9d1b" }, "downloads": -1, "filename": "ckanext-composite-0.0.2.tar.gz", "has_sig": false, "md5_digest": "eb2c09a2330cd4df028617eb2e545101", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12389, "upload_time": "2017-04-19T22:27:56", "url": "https://files.pythonhosted.org/packages/af/87/8770d34cb052396a3629ce65c8d5a08dd686f672e59a8e64bcb4c6cb0154/ckanext-composite-0.0.2.tar.gz" } ] }