{
    "info": {
        "author": "Thorben Werner Sj\u00f8str\u00f8m Dahl",
        "author_email": "thorben@sjostrom.no",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 4 - Beta",
            "License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)",
            "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:: http://unmaintained.tech/badge.svg\n    :target: http://unmaintained.tech/\n    :alt: No Maintenance Intended\n\n.. image:: https://pypip.in/version/ckanext-dataontosearch/badge.svg\n    :target: https://pypi.python.org/pypi/ckanext-dataontosearch/\n    :alt: Latest Version\n\n.. image:: https://pypip.in/py_versions/ckanext-dataontosearch/badge.svg\n    :target: https://pypi.python.org/pypi/ckanext-dataontosearch/\n    :alt: Supported Python versions\n\n.. image:: https://pypip.in/status/ckanext-dataontosearch/badge.svg\n    :target: https://pypi.python.org/pypi/ckanext-dataontosearch/\n    :alt: Development Status\n\n.. image:: https://pypip.in/license/ckanext-dataontosearch/badge.svg\n    :target: https://pypi.python.org/pypi/ckanext-dataontosearch/\n    :alt: License\n\n======================\nckanext-dataontosearch\n======================\n\nExtension for integrating CKAN with DataOntoSearch.\n\nDataOntoSearch is a project which aims to make it easier to find datasets, by using a domain-specific ontology to find similar datasets. The software is run as a separate server, which other projects like CKAN can connect to.\n\nThere are two separate plugins provided with this extension. ``dataontosearch_tagging`` provides a way of associating datasets with concepts in the ontology. (Each such association is internally called a \"tag\", which should not be confused with the traditional tags CKAN provide.) ``dataontosearch_searching`` provides an integrated way of searching using DataOntoSearch.\n\nThe extension adds a link you can follow when editing datasets. From there, you can change what concepts are connected to what datasets.\n\nThe extension also adds a link to the alternative search method. Following it lets you search using DataOntoSearch.\n\n.. IMPORTANT::\n   This extension does not work by itself. It must be paired with a separately\n   deployed version of DataOntoSearch.\n\n.. ATTENTION::\n   Both this and DataOntoSearch should be considered experimental. The majority\n   of the work is done by master students who are not affiliated with the\n   project after their involvement ends.\n\n\n------------\nRequirements\n------------\n\nThis plugin was developed for CKAN version 2.8. We have not checked what other versions it works with, but it does use features introduced in version 2.7.\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-dataontosearch:\n\n1. Ensure that the ckanext-dcat_ extension is installed.\n\n.. _ckanext-dcat: https://github.com/ckan/ckanext-dcat\n\n2. Ensure that CKAN can accept multiple requests in parallel. For example, if\n   you use ``gunicorn`` to run your application, you could use the ``-w`` flag\n   to specify more than 1 worker: ``gunicorn -w 4\u00a0\u2026`` (This is necessary\n   because this extension's request to DataOntoSearch might cause\n   DataOntoSearch to make a request back to CKAN, so the applications would end\n   up waiting for each other in a deadlock.) Note that the ``debug`` setting\n   must be set to ``false`` for CKAN to work in parallel.\n\n3. Activate your CKAN virtual environment, for example::\n\n     . /usr/lib/ckan/default/bin/activate\n\n4. Install the ckanext-dataontosearch Python package into your virtual environment::\n\n     pip install ckanext-dataontosearch\n\n5. Add ``dataontosearch_tagging`` and ``dataontosearch_searching`` 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``). Both are not required, any one of them can be used alone, but that is rather uncommon. They need to be listed after the ``dcat`` plugins.\n\n6. Add required settings::\n\n     # Base URL where dataset_tagger is running\n     ckan.dataontosearch.tagger_url = https://example.com/tagger\n\n     # Base URL where the search for DataOntoSearch is running\n     ckan.dataontosearch.search_url = https://example.com/search\n\n     # The DataOntoSearch Configuration to use\n     ckan.dataontosearch.configuration = 5c7ea259c556bb42803fa17e\n\n7. 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\nThe required settings are described in the installation guide. In addition to those, you may specify the login used when connecting to DataOntoSearch::\n\n    # Username and password to use when querying and tagging datasets in\n    # DataOntoSearch (HTTP Basic Authentication)\n    # (optional, default: no credentials).\n    ckanext.dataontosearch.username = aladdin\n    ckanext.dataontosearch.password = opensesame\n\n\nIn addition, you can also tell the extension to use the autotagged similarity graph when searching, instead of the manual tags::\n\n    # Whether to use the autotagged graph instead of the manual one when\n    # searching (optional, default: no).\n    ckan.dataontosearch.use_autotag = yes\n\n\n------------------------\nDevelopment Installation\n------------------------\n\nTo install ckanext-dataontosearch for development, activate your CKAN virtualenv and\ndo::\n\n    git clone https://github.com/tobinus/ckanext-dataontosearch.git\n    cd ckanext-dataontosearch\n    python setup.py develop\n    pip install -r dev-requirements.txt\n\n\n-----------\nFuture Work\n-----------\n\nThere are plenty of things that should be improved. Here are some of them:\n\n- Integrate concept viewing/editing with the dataset type of view, so the tabs\n  don't disappear once you click on \"Concepts\".\n- Some styling improvements can be done to make it look more appealing and be\n  easier to use.\n- Give feedback to the user when they save concept changes successfully.\n- Use progress indicator of some kind when the user submits concept changes, and\n  stop them from submitting more than once.\n- Give the user an idea of how the concepts relate to one another in a hierarchy,\n  instead of just a flat list. They should only use the most relevant, specific\n  concepts, and not try to fit many \"similar\" concepts, like you would with tags\n  or search words.\n- Give the user more context for each concept. There exist alternate labels that\n  sometimes indicate what other areas that concept is covering, and some even\n  have text that explain and show how to apply that concept. This would require\n  changes to the dataset_tagger API in DataOntoSearch to make the information\n  available to ckanext-dataontosearch.\n- Separate the two different plugins into two different Python files, per the\n  CKAN recommendations (to avoid problems with files loading out of order).\n- Add translations.\n\nThere are also some TODO notes in the source code.\n\n\n-----------------\nRunning the Tests\n-----------------\n\n.. NOTE::\n   No tests have been written for this project yet.\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.dataontosearch --cover-inclusive --cover-erase --cover-tests\n\n\n-------------------------------------------------\nReleasing a New Version of ckanext-dataontosearch\n-------------------------------------------------\n\n.. NOTE::\n   Publishing on PyPi under the same name (ckanext-dataontosearch) is only\n   possible if you receive rights from one who already has access. You should be\n   able to make contact through an author's GitHub user.\n\nckanext-dataontosearch is availabe on PyPI as https://pypi.python.org/pypi/ckanext-dataontosearch.\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 <http://legacy.python.org/dev/peps/pep-0440/#public-version-identifiers>`_\n   for how to choose version numbers, using the principles of `semantic versioning <https://semver.org/>`_.\n\n2. Create a source distribution of the new version::\n\n     python setup.py sdist\n\n3. Upload the source distribution to PyPI (assuming you have run ``pip install twine`` before)::\n\n     twine upload dist/*\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": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/tobinus/ckanext-dataontosearch",
        "keywords": "CKAN search ontology",
        "license": "AGPL",
        "maintainer": "",
        "maintainer_email": "",
        "name": "ckanext-dataontosearch",
        "package_url": "https://pypi.org/project/ckanext-dataontosearch/",
        "platform": "",
        "project_url": "https://pypi.org/project/ckanext-dataontosearch/",
        "project_urls": {
            "Homepage": "https://github.com/tobinus/ckanext-dataontosearch"
        },
        "release_url": "https://pypi.org/project/ckanext-dataontosearch/0.0.6/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "Integration of an externally running DataOntoSearch instance, providing dataset tagging and search",
        "version": "0.0.6"
    },
    "last_serial": 5208624,
    "releases": {
        "0.0.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "1d1d4fbc0c037c472b92c40ff2cd3644",
                    "sha256": "0f71428c1a1021cc5c27f5980000e5f6b281f407d8274d8dcbf70fc75a1605b1"
                },
                "downloads": -1,
                "filename": "ckanext-dataontosearch-0.0.3.tar.gz",
                "has_sig": false,
                "md5_digest": "1d1d4fbc0c037c472b92c40ff2cd3644",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 17909,
                "upload_time": "2019-04-05T10:54:04",
                "url": "https://files.pythonhosted.org/packages/e6/6b/16fe2d49a6ce17b4113e2a51adcc5bab3c37aac89a19f7b1016b0dcd750f/ckanext-dataontosearch-0.0.3.tar.gz"
            }
        ],
        "0.0.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "343601018ef5b7421a8ba16a34339bc5",
                    "sha256": "c25c1e0b79e4af3c8bcaae982cd01cbfcc9e3724edf82011d6cf9ab98bc728de"
                },
                "downloads": -1,
                "filename": "ckanext-dataontosearch-0.0.4.tar.gz",
                "has_sig": false,
                "md5_digest": "343601018ef5b7421a8ba16a34339bc5",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 22089,
                "upload_time": "2019-04-23T14:04:43",
                "url": "https://files.pythonhosted.org/packages/96/f1/1c8b5fd60c71bd5b80d593ae3a63c35e71299fa74852c9df21cd3f0d2a4e/ckanext-dataontosearch-0.0.4.tar.gz"
            }
        ],
        "0.0.5": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "ce0e03c0c6af033b4754b5cd8d97a191",
                    "sha256": "28052190957b68bd97b095157fbb003e681b0490033809f69ab54c2ed753e38c"
                },
                "downloads": -1,
                "filename": "ckanext-dataontosearch-0.0.5.tar.gz",
                "has_sig": false,
                "md5_digest": "ce0e03c0c6af033b4754b5cd8d97a191",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 27398,
                "upload_time": "2019-04-29T10:31:44",
                "url": "https://files.pythonhosted.org/packages/25/c1/b3a6efc5492077d300c9f3545d725aa695b78a74071baad6a6a241a50676/ckanext-dataontosearch-0.0.5.tar.gz"
            }
        ],
        "0.0.6": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "c37dfee3b657e1a2b92db0014e3e697a",
                    "sha256": "931ca94600a386d272d28b17915f1b8b000359cbf0adb1d22c458cdfdc8b1bce"
                },
                "downloads": -1,
                "filename": "ckanext-dataontosearch-0.0.6.tar.gz",
                "has_sig": false,
                "md5_digest": "c37dfee3b657e1a2b92db0014e3e697a",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 27428,
                "upload_time": "2019-04-30T15:05:05",
                "url": "https://files.pythonhosted.org/packages/00/c7/33a8ad8dcc6e3d7a866acc1f2fe13b7216e4e54ef25e88cf6868469b7c60/ckanext-dataontosearch-0.0.6.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "c37dfee3b657e1a2b92db0014e3e697a",
                "sha256": "931ca94600a386d272d28b17915f1b8b000359cbf0adb1d22c458cdfdc8b1bce"
            },
            "downloads": -1,
            "filename": "ckanext-dataontosearch-0.0.6.tar.gz",
            "has_sig": false,
            "md5_digest": "c37dfee3b657e1a2b92db0014e3e697a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 27428,
            "upload_time": "2019-04-30T15:05:05",
            "url": "https://files.pythonhosted.org/packages/00/c7/33a8ad8dcc6e3d7a866acc1f2fe13b7216e4e54ef25e88cf6868469b7c60/ckanext-dataontosearch-0.0.6.tar.gz"
        }
    ]
}