gitphp 0.2.9.1 :: ckanext-datagovau.git/commitdiff

correct plugin name

2 files changed: (show all)
README.txt
setup.py

file:a/README.txt -> file:b/README.txt

This CKAN Extension demonstrates some common patterns for customising a CKAN instance.	This CKAN Extension demonstrates some common patterns for customising a CKAN instance.

It comprises:	It comprises:

* A CKAN Extension "plugin" at ``ckanext/exampletheme/__init__.py``	* A CKAN Extension "plugin" at ``ckanext/exampletheme/__init__.py``
which, when loaded, overrides various settings in the core	which, when loaded, overrides various settings in the core
``ini``-file to provide:	``ini``-file to provide:

* A path to local customisations of the core templates and stylesheets	* A path to local customisations of the core templates and stylesheets
* A "stream filter" that replaces arbitrary strings in rendered templates	* 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 "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 Pylons controller for overriding some core CKAN behaviour

* A custom Package edit form	* A custom Package edit form

* Some simple template customisations	* Some simple template customisations

	Installation
	============

	To install this package, from your CKAN virtualenv, run the following from your CKAN base folder (e.g. ``pyenv/``)::

	pip install -e hg+https://bitbucket.org/okfn/ckanext-exampletheme#egg=ckanext-exampletheme

	Then activate it by setting ``ckan.plugins = exampletheme`` in your main ``ini``-file.


	Orientation
	===========

	* Examine the source code, starting with ``ckanext/exampletheme/__init__.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/exampletheme/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

file:a/setup.py -> file:b/setup.py

from setuptools import setup, find_packages	from setuptools import setup, find_packages
import sys, os	import sys, os

version = '0.1'	version = '0.1'

setup(	setup(
name='ckanext-exampletheme',	name='ckanext-exampletheme',
version=version,	version=version,
description="Example themeb for customising CKAN",	description="Example themeb for customising CKAN",
long_description="""\	long_description="""\
""",	""",
classifiers=[], # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers	classifiers=[], # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers
keywords='',	keywords='',
author='Seb Bacon',	author='Seb Bacon',
author_email='seb.bacon@gmail.com',	author_email='seb.bacon@gmail.com',
url='',	url='',
license='',	license='',
packages=find_packages(exclude=['ez_setup', 'examples', 'tests']),	packages=find_packages(exclude=['ez_setup', 'examples', 'tests']),
namespace_packages=['ckanext', 'ckanext.exampletheme'],	namespace_packages=['ckanext', 'ckanext.exampletheme'],
include_package_data=True,	include_package_data=True,
zip_safe=False,	zip_safe=False,
install_requires=[	install_requires=[
# -- Extra requirements: --	# -- Extra requirements: --
],	],
entry_points=\	entry_points=\
"""	"""
[ckan.plugins]	[ckan.plugins]
datagm=ckanext.exampletheme:ExampleThemePlugin	exampletheme=ckanext.exampletheme:ExampleThemePlugin

[ckan.forms]	[ckan.forms]
example_form = ckanext.exampletheme.package_form:get_example_fieldset	example_form = ckanext.exampletheme.package_form:get_example_fieldset
""",	""",
)	)