https://github.com/ckan/ckanext-intro
A quick interactive introduction to writing CKAN extensions
https://github.com/ckan/ckanext-intro
Last synced: 9 months ago
JSON representation
A quick interactive introduction to writing CKAN extensions
- Host: GitHub
- URL: https://github.com/ckan/ckanext-intro
- Owner: ckan
- Created: 2013-09-15T13:09:39.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2013-09-15T13:13:10.000Z (over 12 years ago)
- Last Synced: 2025-04-04T17:51:47.102Z (9 months ago)
- Language: Python
- Size: 113 KB
- Stars: 6
- Watchers: 15
- Forks: 10
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
Awesome Lists containing this project
README
ckanext-intro - A quick interactive introduction to writing CKAN extensions
===========================================================================
This is a sample extension, intended as a quick and interactive introduction
to writing CKAN extensions. It was used in the CKAN workshop at OKCon 2013.
This does not go into as much details as the proper tutorials for writing
extensions. Developers willing to start writing CKAN extensions should use
those as they are they provide all necessary detail:
* Writing extensions tutorial:
http://docs.ckan.org/en/latest/extensions/tutorial.html
* Custom theming tutorial:
http://docs.ckan.org/en/latest/extensions/theming.html
This is a work in progress, in the meantime provisional docs can be found
here:
http://docs.ckan.org/en/847-new-theming-docs/theming.html
* Example IDatasetForm:
https://github.com/okfn/ckan/tree/master/ckanext/example_idatasetform
Requisites
==========
* A running source CKAN 2.1 install (http://docs.ckan.org/en/latest/install-from-source.html)
* A sysadmin user
* Some datasets created
Both last operations are described in http://docs.ckan.org/en/latest/getting-started.html
Installation
============
Install the extension as usual, in you activated virtualenv::
pip install -e git+https://github.com/okfn/ckanext-intro.git#egg=ckanext-intro
If you want to jump straight away to the end result, just add the plugin to
your CKAN configuration file::
ckan.plugins = intro_plugin
It is recommended though that you follow the individual steps as described in
the next section.
How it works
============
The repository contains a step-by-step process of building an extension. Each
step is contained in a single commit, and flagged with a git tag (``step1``,
``step2``, ...)
You can move between steps using the ``git checkout`` command. For example to
start on the first step::
git checkout step1
To move to the next step::
git checkout step2
And so on. Once on a particular step, you can see the description of the whole
step and the files changed using the ``git show`` command.
You can also browse the steps on GitHub:
https://github.com/okfn/ckanext-intro/commits