{ "info": { "author": "Brook Elgie", "author_email": "brook.elgie@okfn.org", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "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/ckan/ckanext-showcase.svg?branch=master\n :target: https://travis-ci.org/ckan/ckanext-showcase\n\n.. image:: https://coveralls.io/repos/ckan/ckanext-showcase/badge.svg\n :target: https://coveralls.io/r/ckan/ckanext-showcase\n\n================\nckanext-showcase\n================\n\nShowcase and link to datasets in use. Datasets used in an app, website or\nvisualization, or featured in an article, report or blog post can be showcased\nwithin the CKAN website. Showcases can include an image, description, tags and\nexternal link. Showcases may contain several datasets, helping users discover\nrelated datasets being used together. Showcases can be discovered by searching\nand filtered by tag.\n\nSite sysadmins can promote selected users to become 'Showcase Admins' to help\ncreate, populate and maintain showcases.\n\nckanext-showcase is intended to be a more powerful replacement for the\n'Related Item' feature.\n\n\n------------\nRequirements\n------------\n\n\nCompatible with CKAN 2.3+.\n\nN.B. The ``migrate`` command, detailed below, requires the Related Item models\nand actions, which have been removed in CKAN 2.6. If you wish to migrate your\nRelated Items, please first upgrade CKAN to 2.5, do the migration, then\ncontinue upgrading to CKAN 2.6+.\n\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-showcase:\n\n1. Activate your CKAN virtual environment, for example::\n\n . /usr/lib/ckan/default/bin/activate\n\n2. Install the ckanext-showcase Python package into your virtual environment::\n\n pip install ckanext-showcase\n\n3. Add ``showcase`` 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------------------------\nDevelopment Installation\n------------------------\n\nTo install ckanext-showcase for development, activate your CKAN virtualenv and\ndo::\n\n git clone https://github.com/ckan/ckanext-showcase.git\n cd ckanext-showcase\n python setup.py develop\n pip install -r dev-requirements.txt\n\n\n---\nAPI\n---\n\nAll actions in the Showcase extension are available in the CKAN Action API.\n\nShowcase actions::\n\n - create a new showcase (sysadmins and showcase admins only)\n curl -X POST http://127.0.0.1:5000/api/3/action/ckanext_showcase_create -H \"Authorization:{YOUR-API-KEY}\" -d '{\"name\": \"my-new-showcase\"}'\n\n - delete a showcase (sysadmins and showcase admins only)\n curl -X POST http://127.0.0.1:5000/api/3/action/ckanext_showcase_delete -H \"Authorization:{YOUR-API-KEY}\" -d '{\"name\": \"my-new-showcase\"}'\n\n - show a showcase\n curl -X POST http://127.0.0.1:5000/api/3/action/ckanext_showcase_show -d '{\"id\": \"my-new-showcase\"}'\n\n - list showcases\n curl -X POST http://127.0.0.1:5000/api/3/action/ckanext_showcase_list -d ''\n\n\nDataset actions::\n\n - add a dataset to a showcase (sysadmins and showcase admins only)\n curl -X POST http://127.0.0.1:5000/api/3/action/ckanext_showcase_package_association_create -H \"Authorization:{YOUR-API-KEY}\" -d '{\"showcase_id\": \"my-showcase\", \"package_id\": \"my-package\"}'\n\n - remove a dataset from a showcase (sysadmins and showcase admins only)\n curl -X POST http://127.0.0.1:5000/api/3/action/ckanext_showcase_package_association_delete -H \"Authorization:{YOUR-API-KEY}\" -d '{\"showcase_id\": \"my-showcase\", \"package_id\": \"my-package\"}'\n\n - list datasets in a showcase\n curl -X POST http://127.0.0.1:5000/api/3/action/ckanext_showcase_package_list -d '{\"showcase_id\": \"my-showcase\"}'\n\n - list showcases featuring a given dataset\n curl -X POST http://127.0.0.1:5000/api/3/action/ckanext_package_showcase_list -d '{\"package_id\": \"my-package\"}'\n\n\nShowcase admin actions::\n\n - add showcase admin (sysadmins only)\n curl -X POST http://127.0.0.1:5000/api/3/action/ckanext_showcase_admin_add -H \"Authorization:{YOUR-API-KEY}\" -d '{\"username\": \"bert\"}'\n\n - remove showcase admin (sysadmins only)\n curl -X POST http://127.0.0.1:5000/api/3/action/ckanext_showcase_admin_remove -H \"Authorization:{YOUR-API-KEY}\" -d '{\"username\": \"bert\"}'\n\n - list showcase admins (sysadmins only)\n curl -X POST http://127.0.0.1:5000/api/3/action/ckanext_showcase_admin_list -H \"Authorization:{YOUR-API-KEY}\" -d ''\n\n\n----------------------------\nMigrating from Related Items\n----------------------------\n\nIf you already have Related Items in your database, you can use the ``showcase\nmigrate`` command to create Showcases from Related Items.\n\nFrom the ``ckanext-showcase`` directory::\n\n paster showcase migrate -c {path to production.ini}\n\nNote that each Related Item must have a unique title before migration can\nproceed. If you prefer resolving duplicates as showcases, you can use the --allow-duplicates\noption to migrate them anyways. Duplicate Relations will be created as\n'duplicate_' + original_related_title + '_' + related_id\n\n paster showcase migrate -c {path to production.ini} --allow-duplicates\n\nThe Related Item property ``type`` will become a Showcase tag. The Related Item\nproperties ``created``, ``owner_id``, ``view_count``, and ``featured`` have no\nequivalent in Showcases and will not be migrated.\n\nRelated Item data is not removed from the database by this command.\n\n-----------------\nRunning the Tests\n-----------------\n\nTo run the tests, do::\n\n nosetests --ckan --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 --ckan --nologcapture --with-pylons=test.ini --with-coverage --cover-package=ckanext.showcase --cover-inclusive --cover-erase --cover-tests\n\n\n------------------------------------\nRegistering ckanext-showcase on PyPI\n------------------------------------\n\nckanext-showcase should be availabe on PyPI as\nhttps://pypi.python.org/pypi/ckanext-showcase. 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-showcase\n-------------------------------------------\n\nckanext-showcase is availabe on PyPI as https://pypi.python.org/pypi/ckanext-showcase.\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\n\n\n-------------------------------------------\ni18n\n-------------------------------------------\n\nSee: \"Internationalizing strings in extensions\" : http://docs.ckan.org/en/latest/extensions/translating-extensions.html\n\n1. Install babel\n\n pip install Babel\n\n2. Init Catalog for your language\n\n python setup.py init_catalog -l es\n\n3. Compile your language catalog ( You can force pybabel compile to compile messages marked as fuzzy with the -f)\n\n python setup.py compile_catalog -f -l es\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/ckan/ckanext-showcase", "keywords": "ckan", "license": "AGPL", "maintainer": "", "maintainer_email": "", "name": "ckanext-showcase", "package_url": "https://pypi.org/project/ckanext-showcase/", "platform": "", "project_url": "https://pypi.org/project/ckanext-showcase/", "project_urls": { "Homepage": "https://github.com/ckan/ckanext-showcase" }, "release_url": "https://pypi.org/project/ckanext-showcase/1.0.3/", "requires_dist": null, "requires_python": "", "summary": "A ckan extension to showcase datasets in use", "version": "1.0.3" }, "last_serial": 3754628, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "71770eedd8ee7e5116276e006afecd47", "sha256": "7d74bc647cb9346a0c61e28ed172b9560cc4bf302791c7c7b2a9c09a338df8dc" }, "downloads": -1, "filename": "ckanext-showcase-1.0.0.tar.gz", "has_sig": false, "md5_digest": "71770eedd8ee7e5116276e006afecd47", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 36284, "upload_time": "2015-09-23T15:34:11", "url": "https://files.pythonhosted.org/packages/8f/6b/ad90938ee3ab20102115eba136fa029fd10fadd5322c44ed4ed55891c545/ckanext-showcase-1.0.0.tar.gz" } ], "1.0.0b1": [ { "comment_text": "", "digests": { "md5": "5a3e13a056da4969c1350b30ca4d6964", "sha256": "fa8e83c8dcabf66a2f9f9bcf32e48a3ff7e2d488d31ede28ed7c0bf6aa942b3e" }, "downloads": -1, "filename": "ckanext-showcase-1.0.0b1.tar.gz", "has_sig": false, "md5_digest": "5a3e13a056da4969c1350b30ca4d6964", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 35233, "upload_time": "2015-04-09T14:37:41", "url": "https://files.pythonhosted.org/packages/db/bf/18f899413eb165b0f4762457fdd24d3ec2d91188f1803ca5156db6a099b1/ckanext-showcase-1.0.0b1.tar.gz" } ], "1.0.2": [ { "comment_text": "", "digests": { "md5": "4bbde6039b084a1b298a2aa8d48f1c96", "sha256": "2a0f32453da235a100e3ea2712cb743f8677228ea4d6d1a7cc912102d72bce98" }, "downloads": -1, "filename": "ckanext-showcase-1.0.2.tar.gz", "has_sig": false, "md5_digest": "4bbde6039b084a1b298a2aa8d48f1c96", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 38957, "upload_time": "2016-02-01T15:55:46", "url": "https://files.pythonhosted.org/packages/9b/7e/dc9e80ee91891bc3204a1a4f3305cf7509dd666a2df44a5c2ae106651994/ckanext-showcase-1.0.2.tar.gz" } ], "1.0.3": [ { "comment_text": "", "digests": { "md5": "8546fcc8cbad0409b4dcd1c4959cf27b", "sha256": "391927dd060123b6caf17ba01cc7b6f5d05802d0d160fe59d8cdf5443c71f0fe" }, "downloads": -1, "filename": "ckanext-showcase-1.0.3.tar.gz", "has_sig": false, "md5_digest": "8546fcc8cbad0409b4dcd1c4959cf27b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 44488, "upload_time": "2017-05-26T09:12:28", "url": "https://files.pythonhosted.org/packages/0e/d5/fd739a6bfe863aec44a4b21bc67a978a84f6f2f766e0314a8f9257eada20/ckanext-showcase-1.0.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "8546fcc8cbad0409b4dcd1c4959cf27b", "sha256": "391927dd060123b6caf17ba01cc7b6f5d05802d0d160fe59d8cdf5443c71f0fe" }, "downloads": -1, "filename": "ckanext-showcase-1.0.3.tar.gz", "has_sig": false, "md5_digest": "8546fcc8cbad0409b4dcd1c4959cf27b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 44488, "upload_time": "2017-05-26T09:12:28", "url": "https://files.pythonhosted.org/packages/0e/d5/fd739a6bfe863aec44a4b21bc67a978a84f6f2f766e0314a8f9257eada20/ckanext-showcase-1.0.3.tar.gz" } ] }