{"id":13742267,"url":"https://github.com/datopian/ckanext-orgdashboards","last_synced_at":"2025-07-02T11:06:22.550Z","repository":{"id":141957771,"uuid":"63230802","full_name":"datopian/ckanext-orgdashboards","owner":"datopian","description":":clipboard: CKAN extension for creating organization dashboards :clipboard:","archived":false,"fork":false,"pushed_at":"2018-02-06T12:55:59.000Z","size":897,"stargazers_count":8,"open_issues_count":0,"forks_count":5,"subscribers_count":29,"default_branch":"master","last_synced_at":"2024-08-29T02:02:12.919Z","etag":null,"topics":["ckan","ckan-extension","ckanext"],"latest_commit_sha":null,"homepage":"","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/datopian.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2016-07-13T08:56:27.000Z","updated_at":"2024-08-12T07:50:22.000Z","dependencies_parsed_at":"2024-01-13T01:38:31.278Z","dependency_job_id":"4d4e436c-7e5f-4788-8975-0a914169c6e3","html_url":"https://github.com/datopian/ckanext-orgdashboards","commit_stats":null,"previous_names":["viderumglobal/ckanext-orgdashboards"],"tags_count":39,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datopian%2Fckanext-orgdashboards","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datopian%2Fckanext-orgdashboards/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datopian%2Fckanext-orgdashboards/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datopian%2Fckanext-orgdashboards/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/datopian","download_url":"https://codeload.github.com/datopian/ckanext-orgdashboards/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253165246,"owners_count":21864406,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ckan","ckan-extension","ckanext"],"created_at":"2024-08-03T05:00:26.700Z","updated_at":"2025-05-08T23:33:35.070Z","avatar_url":"https://github.com/datopian.png","language":"CSS","readme":".. 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/ViderumGlobal/ckanext-orgdashboards.svg?branch=master\n    :target: https://travis-ci.org/ViderumGlobal/ckanext-orgdashboards\n.. image:: https://coveralls.io/repos/github/ViderumGlobal/ckanext-orgdashboards/badge.svg?branch=master\n    :target: https://coveralls.io/github/ViderumGlobal/ckanext-orgdashboards?branch=master\n  \n\n=============\nckanext-orgdashboards\n=============\n\nDashboard visualises selected datasets on a single overview screen. You can add graphs, charts, and maps to give a quick summary of the data. For more information about orgdashboard extension follow this tutorial\n`Data dashboards \u003chttps://www.youtube.com/watch?v=Gn32scwuMU4\u003e`_.\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-orgdashboards:\n\n1. Activate your CKAN virtual environment, for example::\n\n     . /usr/lib/ckan/default/bin/activate\n\n2. Install the ckanext-orgdashboards Python package into your virtual environment::\n\n     pip install ckanext-orgdashboards\n\n3. Add ``orgdashboards`` 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. Add ``ckanext.orgdashboards.datasets_per_page`` as a setting in the config file::\n\n    ckanext.orgdashboards.datasets_per_page = 5\n\n5. Add ``ckanext.orgdashboards.organization_entity_name`` as a setting in the config file::\n\n    ckanext.orgdashboards.organization_entity_name = organization\n\nThis setting can either be set to ``country`` or ``organization``. If you set\nit to ``country`` it will use text references for \"Country/Countries\" instead of\n\"Organization/Organizations\" throughout the web interface. Though, this only \napplies to certain parts of the UI. For some, you have to manually override/extend \nthe templates.\n\n6. Add ``ckanext.orgdashboards.group_entity_name`` as a setting in the \nconfig file::\n\n    ckanext.orgdashboards.group_entity_name = group\n\nThis setting can either be set to ``group`` or ``theme``. If you set\nit to ``theme`` it will use text references for \"Theme/Themes\" instead of \n\"Group/Groups\" throughout the web interface. Though, this only applies to \ncertain parts of the UI. For some, you have to manually override/extend the \ntemplates.\n\n7. Add ``ckanext.orgdashboards.custom_dns_active`` as a setting in the\nconfig file::\n\n    ckanext.orgdashboards.custom_dns_active = true\n\nThis setting enables functionality for adding custom domain for individual dashboards.\n\n8. 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\nDocument any optional config settings here. For example::\n\n    # The minimum number of hours to wait before re-checking a resource\n    # (optional, default: 24).\n    ckanext.orgdashboards.some_setting = some_default_value\n\n\n------------------------\nDevelopment Installation\n------------------------\n\nTo install ckanext-orgdashboards for development, activate your CKAN virtualenv and\ndo::\n\n    git clone https://github.com/keitaroinc/ckanext-orgdashboards.git\n    cd ckanext-orgdashboards\n    python setup.py develop\n    pip install -r dev-requirements.txt\n\n------------------------\nLanguages Installation\n------------------------\n\nIn order to use languages that are not supported by CKAN, you have to install\nthem manually. Open up a terminal inside the CKAN's source directory, and type\nthe following command to initialize a new catalog for a language::\n\n    python setup.py init_catalog --locale YOUR_LANGUAGE\n\nwhere ``YOUR_LANGUAGE`` is the locale of the language. This command will \ncreate a ``.po`` file inside ``ckan/i18n/YOUR_LANGUAGE/LC_MESSAGES``\nwhich contains the strings for the language. \n\nNext you have to compile tha language into a binary format with the following\ncommand::\n\n    python setup.py compile_catalog --locale YOUR_LANGUAGE\n\nwhere ``YOUR_LANGUAGE`` is the locale of the language. This command will \ncreate a ``.mo`` file, and the one which CKAN will read the strings from.\n\n------------------------\nLanguages Translation\n------------------------\n\nIf you want to add additional strings for a certain language and translate\nthem, then follow these instructions:\n\n1. Switch to the extension's directory and add a directory to store your \ntranslations::\n\n    mkdir ckanext/orgdashboards/i18n\n\n2. Extract the strings from the extension with this \ncommand::\n\n    python setup.py extract_messages\n\nThis will create a template ``.po`` file named \n``ckanext/orgdashboards/i18n/ckanext-orgdashboards.pot``\n\n3. The next step is to create the translations. Let's say that you want to\ntranslate strings for the ``de`` locale. Create the translation ``.po`` file \nfor the locale that you are translating for by running ``init_catalog``::\n\n    python setup.py init_catalog -l de\n\nThis will generate a file called ``i18n/de/LC_MESSAGES/ckanext-orgdashboards.po``.\nIt contains every string extracted from the extension. For example, if you want\nto translate the string ``Groups``, locate it in the ``.po`` file and type the\nappropriate translation::\n\n    msgid \"Groups\"\n    msgstr \"Gruppen\"\n\nA ``.po`` file can also be edited using a special program for translation called \n`Poedit \u003chttps://poedit.net/\u003e`_.\n\n4. Once you are done with translation, next step is to compile the catalog with\nthe ``compile_catalog`` command::\n    \n    python setup.py compile_catalog -l de\n\nThis will create a binary ``.mo`` file named \n``ckanext/orgdashboards/i18n/ckanext-orgdashboards.mo`` containing your \ntranslations.\n\nOnce you have added the translated strings, you will need to inform CKAN that \nyour extension is translated by implementing the ``ITranslation`` interface in\nyour extension. Edit your ``plugin.py`` to contain the following::\n\n    from ckan.lib.plugins import DefaultTranslation\n\n\n    class YourPlugin(plugins.SingletonPlugin, DefaultTranslation):\n        plugins.implements(plugins.ITranslation)\n\nRestart the server and you should find that switching to the ``de`` locale in \nthe web interface should change the ``Groups`` string.\n\nMore information on translating extensions can be found on the offical\ndocumentation on CKAN.\n\nAdditional flags for countries can be taken from http://flag-icon-css.lip.is\n\n-----------------\nRunning the Tests\n-----------------\n\nSome of the tests require that you run a CKAN server, the one where the\norgdashboards extension is installed. \n\nFirst create a new database called ``ckan_test`` if you haven't already, and \nin the config file for the server change the ``sqlalchemy.url`` to point to the\ndatabase ``ckan_test``. This database will be used by the tests.\n\nAnd second, set a storage path in the config file where uploaded resources will\nbe stored.\n\nckan.storage_path = /path/to/storage\n\nTo run the tests, change the current working directory to the extension and do::\n\n    nosetests --ckan --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.orgdashboards --cover-inclusive --cover-erase --cover-tests\n\n\n---------------------------------\nRegistering ckanext-orgdashboards on PyPI\n---------------------------------\n\nckanext-orgdashboards should be availabe on PyPI as\nhttps://pypi.python.org/pypi/ckanext-orgdashboards. 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-orgdashboards\n----------------------------------------\n\nckanext-orgdashboards is availabe on PyPI as https://pypi.python.org/pypi/ckanext-orgdashboards.\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 \u003chttp://legacy.python.org/dev/peps/pep-0440/#public-version-identifiers\u003e`_\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","funding_links":[],"categories":["Extensions"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatopian%2Fckanext-orgdashboards","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdatopian%2Fckanext-orgdashboards","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatopian%2Fckanext-orgdashboards/lists"}