From: Alex Sadleir Date: Tue, 03 Sep 2013 01:06:17 +0000 Subject: initial commit X-Git-Url: https://maxious.lambdacomplex.org/git/?p=ckanext-datagovau.git&a=commitdiff&h=229c0ab1ba00d5037bb11c5d32919ee6fee79dcd --- initial commit --- --- a/.gitignore +++ b/.gitignore @@ -7,4 +7,4 @@ .#* build/ dist/ - +distribute-* --- /dev/null +++ b/.idea/other.xml @@ -1,1 +1,8 @@ + + + + + + --- /dev/null +++ b/.idea/testrunner.xml @@ -1,1 +1,9 @@ + + + + + + --- a/README.rst +++ b/README.rst @@ -1,56 +1,21 @@ -This CKAN Extension demonstrates some common patterns for customising a CKAN instance. +This CKAN Extension customises a CKAN instance for the hosting of data.gov.au. It comprises: -* A CKAN Extension "plugin" at ``ckanext/example/plugin.py`` which, when +* A CKAN Extension "plugin" at ``ckanext/datagovau/plugin.py`` which, when loaded, overrides various settings in the core ``ini``-file to provide: - - * A path to local customisations of the core templates and stylesheets - * A "stream filter" that replaces arbitrary strings in rendered templates - * A "route" to override and extend the default behaviour of a core CKAN page - -* A custom Pylons controller for overriding some core CKAN behaviour - -* A custom Package edit form - -* Some simple template customisations + * A path to local customisations of the core templates and available licenses database + * A custom Package edit form + * A custom n3/rdf output format Installation ============ To install this package, from your CKAN virtualenv, run the following from your CKAN base folder (e.g. ``pyenv/``):: - pip install -e git+https://github.com/okfn/ckanext-example#egg=ckanext-example + pip install -e git+https://github.com/okfn/ckanext-datagovau#egg=ckanext-datagovau -Then activate it by setting ``ckan.plugins = example`` in your main ``ini``-file. +Then activate it by setting ``ckan.plugins = datagovau`` in your main ``ini``-file. -Orientation -=========== -* Examine the source code, starting with ``ckanext/example/plugin.py`` - -* To understand the nuts and bolts of this file, which is a CKAN - *Extension*, read in conjunction with the "Extension - documentation":http://packages.python.org/ckan/plugins.html - -* One thing the extension does is set the values of - ``extra_public_paths`` and ``extra_template_paths`` in the CKAN - config, which are "documented - here":http://packages.python.org/ckan/configuration.html#extra-template-paths - -* These are set to point at directories within - `ckanext/example/theme/`` (in this package). Here, we override - the home page, provide some extra style with an ``extra.css``, and - customise the navigation and header of the main template in the file ``layout.html``. - - The latter file is a great place to make global theme alterations. - It uses the _layout template_ pattern "described in the Genshi - documentation":http://genshi.edgewall.org/wiki/GenshiTutorial#AddingaLayoutTemplate. - This allows you to use Xpath selectors to override snippets of HTML - globally. - -* The custom package edit form at ``package_form.py`` follows the - conventions in the "main CKAN - documentation":http://packages.python.org/ckan/forms.html - --- /dev/null +++ b/ckanext-datagovau.iml @@ -1,1 +1,13 @@ + + + + + + + + + + + + --- /dev/null +++ b/ckanext/datagovau/templates/package/read_base.html @@ -1,1 +1,15 @@ +{% ckan_extends %} +{% block subtitle %}{{ pkg.title or pkg.name }}{% endblock %} + +{% block links -%} +{{ super() }} + +{% endblock -%} + +{% block head_extras -%} +{{ super() }} + +{% endblock -%} + + --- a/ckanext/example/__init__.py +++ /dev/null @@ -1,2 +1,1 @@ -# package --- a/ckanext/example/controller.py +++ /dev/null @@ -1,40 +1,1 @@ -import sys -from ckan.lib.base import request -from ckan.lib.base import c, g, h -from ckan.lib.base import model -from ckan.lib.base import render -from ckan.lib.base import _ -from ckan.controllers.user import UserController - - -class CustomUserController(UserController): - """This controller is an example to show how you might extend or - override core CKAN behaviour from an extension package. - - It duplicates functionality in the core CKAN UserController's - register function, but extends it to make an email address - mandatory. - """ - def custom_register(self): - if request.method == 'POST': - # custom validation that requires an email address - error = False - c.email = request.params.getone('email') - c.login = request.params.getone('login') - if not model.User.check_name_available(c.login): - error = True - h.flash_error(_("That username is not available.")) - if not c.email: - error = True - h.flash_error(_("You must supply an email address.")) - try: - self._get_form_password() - except ValueError, ve: - h.flash_error(ve) - error = True - if error: - return render('user/register.html') - # now delegate to core CKAN register method - return self.register() - --- a/ckanext/example/package_form.py +++ /dev/null @@ -1,40 +1,1 @@ -from sqlalchemy.util import OrderedDict -from pylons.i18n import _ -from ckan.forms import common -from ckan.forms import package - - -# Setup the fieldset -def build_example_form(is_admin=False, - user_editable_groups=None, - **kwargs): - """Customise the core CKAN dataset editing form by adding a new - field "temporal coverage", and changing the layout of the core - fields. - """ - # Restrict fields - builder = package.build_package_form( - user_editable_groups=user_editable_groups) - - # Extra fields - builder.add_field(common.DateRangeExtraField('temporal_coverage')) - - # Layout - field_groups = OrderedDict([ - (_('Customised Basic information'), ['title', 'name', 'url', - 'notes', 'tags']), - (_('Details'), ['author', 'author_email', 'groups', - 'maintainer', 'maintainer_email', - 'license_id', 'temporal_coverage' ]), - (_('Resources'), ['resources']), - ]) - builder.set_displayed_fields(field_groups) - return builder - - -def get_example_fieldset(is_admin=False, user_editable_groups=None, **kwargs): - return build_example_form(is_admin=is_admin, - user_editable_groups=user_editable_groups, - **kwargs).get_fieldset() - --- a/ckanext/example/plugin.py +++ /dev/null @@ -1,93 +1,1 @@ -import os -from logging import getLogger -from genshi.filters.transform import Transformer - -from ckan.plugins import implements, SingletonPlugin -from ckan.plugins import IConfigurer -from ckan.plugins import IGenshiStreamFilter -from ckan.plugins import IRoutes - -log = getLogger(__name__) - - -class ExamplePlugin(SingletonPlugin): - """This plugin demonstrates how a theme packaged as a CKAN - extension might extend CKAN behaviour. - - In this case, we implement three extension interfaces: - - - ``IConfigurer`` allows us to override configuration normally - found in the ``ini``-file. Here we use it to specify the site - title, and to tell CKAN to look in this package for templates - and resources that customise the core look and feel. - - ``IGenshiStreamFilter`` allows us to filter and transform the - HTML stream just before it is rendered. In this case we use - it to rename "frob" to "foobar" - - ``IRoutes`` allows us to add new URLs, or override existing - URLs. In this example we use it to override the default - ``/register`` behaviour with a custom controller - """ - implements(IConfigurer, inherit=True) - implements(IGenshiStreamFilter, inherit=True) - implements(IRoutes, inherit=True) - - def update_config(self, config): - """This IConfigurer implementation causes CKAN to look in the - ```public``` and ```templates``` directories present in this - package for any customisations. - - It also shows how to set the site title here (rather than in - the main site .ini file), and causes CKAN to use the - customised package form defined in ``package_form.py`` in this - directory. - """ - here = os.path.dirname(__file__) - rootdir = os.path.dirname(os.path.dirname(here)) - our_public_dir = os.path.join(rootdir, 'ckanext', - 'example', 'theme', 'public') - template_dir = os.path.join(rootdir, 'ckanext', - 'example', 'theme', - 'templates') - # set our local template and resource overrides - config['extra_public_paths'] = ','.join([our_public_dir, - config.get('extra_public_paths', '')]) - config['extra_template_paths'] = ','.join([template_dir, - config.get('extra_template_paths', '')]) - # set the title - config['ckan.site_title'] = "An example CKAN theme" - # set the customised package form (see ``setup.py`` for entry point) - config['package_form'] = "example_form" - - def filter(self, stream): - """Conform to IGenshiStreamFilter interface. - - This example filter renames 'frob' to 'foobar' (this string is - found in the custom ``home/index.html`` template provided as - part of the package). - """ - stream = stream | Transformer('//p[@id="examplething"]/text()')\ - .substitute(r'frob', r'foobar') - return stream - - def before_map(self, map): - """This IRoutes implementation overrides the standard - ``/user/register`` behaviour with a custom controller. You - might instead use it to provide a completely new page, for - example. - - Note that we have also provided a custom register form - template at ``theme/templates/user/register.html``. - """ - # Note that when we set up the route, we must use the form - # that gives it a name (i.e. in this case, 'register'), so it - # works correctly with the url_for helper:: - # h.url_for('register') - map.connect('register', - '/user/register', - controller='ckanext.example.controller:CustomUserController', - action='custom_register') - map.connect('/package/new', controller='package_formalchemy', action='new') - map.connect('/package/edit/{id}', controller='package_formalchemy', action='edit') - return map - --- a/ckanext/example/theme/public/css/extra.css +++ /dev/null @@ -1,5 +1,1 @@ -body { - background-color: pink; -} - --- a/ckanext/example/theme/templates/home/index.html +++ /dev/null @@ -1,29 +1,1 @@ - - Home - - - - - -
-

Welcome to Example Theme!

-

- This page left intentionally ugly -

-

- Here is the frob -

-
- - - - --- a/ckanext/example/theme/templates/layout.html +++ /dev/null @@ -1,33 +1,1 @@ - - - -
-
    -
  • ${h.nav_link(c, _('Home'), controller='home', action='index', id=None)} -
    • -
  • ${h.nav_link(c, _('Data'), controller='package', action='index', id=None)} -
    • -
-
- - - - -
-
- - -
-
- - - - - --- a/ckanext/example/theme/templates/user/register.html +++ /dev/null @@ -1,49 +1,1 @@ - - - -
  • -

    Have an OpenID?

    -

    - If you have an account with Google, Yahoo or one of many other - OpenID providers, you can log in without signing up. -

    -
      -
    • ${h.link_to(_('Log in now'), h.url_for(conroller='user', action='login'))}
      • -
    -
    • -     - - Register - User -
    -

    Join the community

    - -
    -
    - Register with CKAN - - - -
    - - -
    - - -
    - - -
    - - -
    -
    - ${h.submit('s', _('Sign up'))} -
    -
    - - - --- a/rename.sh +++ /dev/null @@ -1,14 +1,1 @@ -if [ $# -ne 1 ]; then - echo "Usage: `basename $0` {NewExtensionName}" - exit 65 -fi -NEWNAME=$1 -NEWNAME_LOWER="`echo $NEWNAME | awk '{print tolower($0)}'`" -echo $NEWNAME_LOWER -mv ckanext/example ckanext/$NEWNAME_LOWER -grep -rl Example * | grep -v `basename $0` | xargs perl -pi -e "s/Example/$NEWNAME/g" -grep -rl example * | grep -v `basename $0` | xargs perl -pi -e "s/example/$NEWNAME_LOWER/g" -cd .. -mv ckanext-example ckanext-$NEWNAME_LOWER - --- a/setup.py +++ b/setup.py @@ -1,34 +1,27 @@ from setuptools import setup, find_packages -import sys, os version = '0.1' setup( - name='ckanext-example', + name='ckanext-datagovau', version=version, - description="Example extension for customising CKAN", - long_description="""\ - """, + description='Extension for customising CKAN for data.gov.au', + long_description='', classifiers=[], # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers keywords='', - author='Seb Bacon', - author_email='seb.bacon@gmail.com', + author='Alex Sadleir', + author_email='alex.sadleir@linkdigital.com.au', url='', license='', packages=find_packages(exclude=['ez_setup', 'examples', 'tests']), - namespace_packages=['ckanext', 'ckanext.example'], + namespace_packages=['ckanext', 'ckanext.datagovau'], include_package_data=True, zip_safe=False, - install_requires=[ - # -*- Extra requirements: -*- - ], + install_requires=[], entry_points=\ """ [ckan.plugins] - example=ckanext.example.plugin:ExamplePlugin - - [ckan.forms] - example_form = ckanext.example.package_form:get_example_fieldset + datagovau=ckanext.datagovau.plugin:ExampleIDatasetFormPlugin """, )