ckan /

Filename Size Date modified Message
bin
ckan
ckan.egg-info
doc
188 B
502 B
5.3 KB
89 B
679 B
2.6 KB
207 B
712 B
18.3 KB
266 B
382 B
348 B
1.1 KB
2.5 KB
550 B
367 B
370 B
151 B
957 B
README
++++++

Introduction
============

Comprehensive Knowledge Archive Network (CKAN) Software.

See :mod:`ckan.__long_description__` for more information.


Developer Installation
======================

1. Get the code and install it:

   We recommend installing using pip and virtualenv::
   
      # grab the install requirements from the ckan mercurial repo
      # Or checkout the mercurial repo directly!
      wget http://knowledgeforge.net/ckan/hg/raw-file/tip/pip-requirements.txt
      # create a virtualenv to install into
      virtualenv pyenv-ckan
      # install using pip-requirements
      pip -E pyenv-ckan install -r pip-requirements.txt

3. Make a config file as follows::

      # NB: you need to activate the virtualenv
      paster --plugin ckan make-config ckan {your-config.ini}

4. Tweak the config file as appropriate and then setup the application::

      paster --plugin ckan setup-app {your-config.ini}

   NB: you'll need to setup a database -- see sqlalchemy.url config option.
   We support only PostgreSQL at this time. You'll need to install the relevant
   python library (eg. On debiani/ubuntu: python-psycopg2)

   NB: You may also need to create the Pylon's cache directory specified by
   cache_dir in the config file.

5. Run the webserver::

      paster serve {your-config.ini} 

6. Point your browser at: localhost:5000 (if you set a different port in your
   config file then youl will need to change 5000 to whatever port value you
   chose).


Test
====

Make sure you've created a config called development.ini, then:: 

    nosetests ckan/tests


Documentation
=============

The home page for the CKAN project is: http://knowledgeforge.net/ckan

This file is part of the developer docs. The complete developer docs are built from the ckan repository using Sphinx and uploaded by an admin to KnowledgeForge. To build the developer docs::

      python setup.py build_sphinx
 

Contributors
============

  * Rufus Pollock <rufus [at] rufuspollock [dot] org>
  * David Read
  * John Bywater
  * Nick Stenning (css and js)

Also especial thanks to the following projects without whom this would not have
been possible:

  * CKAN logo: "angry hamster" http://www.maedelmaedel.com/ and
    http://www.villainous.biz/
  * famfamfam.com for silk icons <http://www.famfamfam.com/lab/icons/silk/>
  * Pylons: <http://pylonshq.com/>
  * Python: <http://www.python.org>


Copying and License
===================

This material is copyright (c) 2006-2009 Open Knowledge Foundation.

It is open and licensed under the GNU Affero General Public License (AGPL) v3.0
whose full text may be found at:

<http://www.fsf.org/licensing/licenses/agpl-3.0.html>

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.