Source

ckan /

Filename Size Date modified Message
bin
ckan
ckan.egg-info
doc
106 B
400 B
3.8 KB
89 B
679 B
2.9 KB
650 B
273 B
1.1 KB
2.1 KB
563 B
2.4 KB
957 B

Introduction

Comprehensive Knowledge Archive Network (CKAN) Software.

See ckan.__long_description__ for more information.

Installation and Setup

  1. Get the code and install it:

    We recommend installing using pip and virtualenv:

    # grab the install requirements from the ckan mercurial repo
    wget http://knowledgeforge.net/ckan/hg/raw-file/tip/pip-requirements.txt
    # create a virtualenv to install into
    virtualenv --no-site-packages pyenv-ckan
    # install using pip-requirements
    pip -E pyenv-ckan install -r pip-requirements.txt
    
  1. Make a config file as follows:

    # NB: you need to activate the repository
    paster --plugin ckan make-config ckan config.ini
    
  2. Tweak the config file as appropriate and then setup the application:

    paster --plugin ckan setup-app config.ini
    

NB: you'll need to setup a database -- see sqlalchemy.url config option. We support any database supported by sqlalchemy.

  1. Run the webserver:

    paster serve config.ini
    
  2. Point your browswer 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).

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:

Test

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

nosetests ckan/tests

## Copying

This material is open and licensed under the MIT license as follows:

Copyright (c) 2006-2009 Open Knowledge Foundation.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.