initial commit
--- /dev/null
+++ b/.idea/other.xml
@@ -1,1 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+ <component name="PyDocumentationSettings">
+ <option name="myDocStringFormat" value="Plain" />
+ </component>
+</project>
+
--- /dev/null
+++ b/.idea/testrunner.xml
@@ -1,1 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+ <component name="TestRunnerService">
+ <option name="projectConfiguration" value="Unittests" />
+ <option name="PROJECT_TEST_RUNNER" value="Unittests" />
+ </component>
+</project>
+
--- 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
-
-* A custom User registration and edition 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://docs.ckan.org/en/latest/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://docs.ckan.org/en/latest/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 HTML ``ckanext/example/theme/templates/home/index.html``
- * provide some extra style by serving ``extra.css`` (which is loaded using the ``ckan.template_head_end`` option
- * 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.
-
-
--- /dev/null
+++ b/ckanext-datagovau.iml
@@ -1,1 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="PYTHON_MODULE" version="4">
+ <component name="NewModuleRootManager" inherit-compiler-output="true">
+ <exclude-output />
+ <content url="file://$MODULE_DIR$">
+ <sourceFolder url="file://$MODULE_DIR$" isTestSource="false" />
+ </content>
+ <orderEntry type="inheritedJdk" />
+ <orderEntry type="sourceFolder" forTests="false" />
+ </component>
+</module>
+
--- /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() }}
+<link rel="lol" type="test"/>
+{% endblock -%}
+
+{% block head_extras -%}
+{{ super() }}
+<meta property="og:gon" content="lol">
+{% endblock -%}
+
+
--- a/ckanext/example/__init__.py
+++ /dev/null
@@ -1,2 +1,1 @@
-# package
--- a/ckanext/example/controller.py
+++ /dev/null
@@ -1,53 +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.lib.navl.validators import not_empty
-
-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 overrides 2 method hooks which the base class uses to create the
- validation schema for the creation and editing of a user; to require
- that a fullname is given.
- """
-
- new_user_form = 'user/register.html'
-
- def _add_requires_full_name_to_schema(self, schema):
- """
- Helper function that modifies the fullname validation on an existing schema
- """
- schema['fullname'] = [not_empty, unicode]
-
- def _new_form_to_db_schema(self):
- """
- Defines a custom schema that requires a full name to be supplied
-
- This method is a hook that the base class calls for the validation
- schema to use when creating a new user.
- """
- schema = super(CustomUserController, self)._new_form_to_db_schema()
- self._add_requires_full_name_to_schema(schema)
- return schema
-
- def _edit_form_to_db_schema(self):
- """
- Defines a custom schema that requires a full name cannot be removed
- when editing the user.
-
- This method is a hook that the base class calls for the validation
- schema to use when editing an exiting user.
- """
- schema = super(CustomUserController, self)._edit_form_to_db_schema()
- self._add_requires_full_name_to_schema(schema)
- return schema
-
-
--- 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,100 +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', '')])
- # add in the extra.css
- config['ckan.template_head_end'] = config.get('ckan.template_head_end', '') +\
- '<link rel="stylesheet" href="/css/extra.css" type="text/css"> '
- # set the title
- config['ckan.site_title'] = "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``.
- """
- # Hook in our custom user controller at the points of creation
- # and edition.
- map.connect('/user/register',
- controller='ckanext.example.controller:CustomUserController',
- action='register')
- map.connect('/user/edit',
- controller='ckanext.example.controller:CustomUserController',
- action='edit')
- map.connect('/user/edit/{id:.*}',
- controller='ckanext.example.controller:CustomUserController',
- action='edit')
-
- 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 @@
-<html xmlns:py="http://genshi.edgewall.org/"
- xmlns:i18n="http://genshi.edgewall.org/i18n"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- py:strip="">
- <py:def function="page_title">Home</py:def>
-
- <py:def function="optional_head">
- <style type="text/css">
- #examplething {
- background-color: yellow;
- padding: 10px;
- }
- </style>
- </py:def>
-
- <div py:match="content">
- <h2>Welcome to Example Theme!</h2>
- <p>
- This page left intentionally ugly
- </p>
- <p id="examplething">
- Here is the frob
- </p>
- </div>
-
- <xi:include href="layout.html" />
-</html>
-
--- a/ckanext/example/theme/templates/layout.html
+++ /dev/null
@@ -1,30 +1,1 @@
-<html xmlns="http://www.w3.org/1999/xhtml"
- xmlns:py="http://genshi.edgewall.org/"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- xmlns:doap="http://usefulinc.com/ns/doap"
- xmlns:foaf="http://xmlns.com/foaf/0.1/"
- py:strip=""
- >
-<!-- ! a custom primary nav -->
- <py:match path="//div[@class='menu']">
- <div class="menu">
- ${h.nav_link(c, _('Home'), controller='home', action='index', id=None)}
- ${h.nav_link(c, _('Data'), controller='package', action='index', id=None)}
- ${h.nav_link(c, _('New dataset'), controller='package', action='new', id=None)}
- </div>
- </py:match>
-
-<!-- make a really big search box in the top bar -->
- <py:match path="//div[@id='top-bar']/div[@class='search-form']">
- <div class="search-form">
- <form action="${url(controller='package', action='search')}" method="GET">
- <input type="search" class="search" name="q" value="" autocomplete="off" results="5" placeholder="What are you looking for?" id="bigsearch" />
- <input type="submit" class="searchbutton" value="search" />
- </form>
- </div>
- </py:match>
-
- <xi:include href="layout_base.html" />
-</html>
-
--- a/ckanext/example/theme/templates/user/register.html
+++ /dev/null
@@ -1,50 +1,1 @@
-<form id="user-edit" action="" method="post"
- py:attrs="{'class':'has-errors'} if errors else {}"
- xmlns:i18n="http://genshi.edgewall.org/i18n"
- xmlns:py="http://genshi.edgewall.org/"
- xmlns:xi="http://www.w3.org/2001/XInclude">
-<div class="error-explanation" py:if="error_summary">
-<h2>Errors in form</h2>
-<p>The form contains invalid entries:</p>
-<ul>
- <li py:for="key, error in error_summary.items()">${"%s: %s" % (key, error)}</li>
-</ul>
-</div>
-
- <dl>
- <dt><label class="field_opt" for="name">Login:</label></dt>
- <dd><input type="text" name="name" value="${data.get('name','')}" /></dd>
- <dd class="instructions basic">3+ chars, using only 'a-z0-9' and '-_'</dd>
- <dd class="field_error" py:if="errors.get('name', '')">${errors.get('name', '')}</dd>
-
- <dt><label class="field_opt" for="fullname">Full name:</label></dt>
- <dd><input type="text" name="fullname" value="${data.get('fullname','')}" /></dd>
- <dd class="field_error" py:if="errors.get('fullname', '')">${errors.get('fullname', '')}</dd>
-
- <dt><label class="field_opt" for="email">E-Mail</label></dt>
- <dd><input type="text" name="email" value="${data.get('email','')}" /></dd>
-
- <dt><label class="field_opt" for="password1">Password:</label></dt>
- <dd><input type="password" name="password1" value="" /></dd>
- <dd class="field_error" py:if="errors.get('password1', '')">${errors.get('password1', '')}</dd>
-
- <dt><label class="field_opt" for="password2">Password (repeat):</label></dt>
- <dd><input type="password" name="password2" value="" /></dd>
-
- <dd py:if="g.recaptcha_publickey">
- <script type="text/javascript"
- src="http://www.google.com/recaptcha/api/challenge?k=${g.recaptcha_publickey}">
- </script>
- <noscript>
- <iframe src="http://www.google.com/recaptcha/api/noscript?k=${g.recaptcha_publickey}"
- height="300" width="500" frameborder="0"></iframe><br/>
- <textarea name="recaptcha_challenge_field" rows="3" cols="40"> </textarea>
- <input type="hidden" name="recaptcha_response_field" value="manual_challenge" />
- </noscript>
- </dd>
-
- </dl>
- <input id="save" name="save" type="submit" class="pretty-button primary" value="Register now »" />
-</form>
-
--- 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
""",
)