youckan Documentation

Transcription

1 youckan Documentation Release dev Axel Haustant May 26, 2014

2

3 Contents 1 Compatibility 3 2 Installation 5 3 Documentation Configuration Deployment YouCKAN SSO API Contributing Changelog Indices and tables 13 i

4 ii

5 A social frontend to CKAN Contents 1

6 2 Contents

7 CHAPTER 1 Compatibility YouCKAN requires Python 2.7 3

8 4 Chapter 1. Compatibility

9 CHAPTER 2 Installation You can install youckan with pip: $ pip install youckan or with easy_install: $ easy_install youckan YouCKAN use yuglify to compress assets and less to compile LESS to CSS files. You can install them with npm: $ npm install -g less yuglify 5

10 6 Chapter 2. Installation

11 CHAPTER 3 Documentation The documentation is hosted on Read the Docs Contents: 3.1 Configuration YouCKAN use a single ini file for its configuration Sample You can generate a sample configuration by running: $ youckan genconf # or $ youckan-auth genconf You will be asked some questions and have as a result the following ini file: [site] debug = false secret = +hant#30d^df=1$vbolo3p+6t6xdio5312@a63-8b^96q3n-u@ allowed_hosts = admins = language = fr timezone = Europe/Paris [db] default = sqlite://youckan.sqlite ckan = postgres://ckan_default:ckan_default@localhost/ckan_default [ ] webmaster = webmaster@youckan admin = admin@youckan [etalab] domain = my-domain.com ckan_url = home_url = wiki_url = wiki_api_url = 7

12 questions_url = [path] static = staticroot static_url = /static/ media = media media_url = /media/ [social:twitter] key = secret = [social:google] key = secret = [social:linkedin] key = secret = [log] level = warning file = {name}.log [celery] broker = django:// backend = database Feel free to customize it for your needs Advanced customization YouCKAN configuration is extensible as its only standard django configuration. You can either extend an existing configuration: from youckan.settings import * MY_OVERRIDEN_SETTING = my.value or start a new one from scratch. 3.2 Deployment Environment creation $ mkdir -p $YOUCKAN_HOME $ cd $YOUCKAN_HOME $ virtualenv. $ source bin/activate $ pip install youckan $ mkdir media As a postgresql administrator: 8 Chapter 3. Documentation

13 $ createuser youckan -P $ createdb youckan -O youckan -E UTF Configuration $ youckan genconf --ini $ vim youckan.ini Initialisation $ youckan init [--noinput] If --noinput is specified, no questions will be asked and the initialization will run in unattended mode. You can create a super user at anytime with: $ youckan createsuperuser Upgrade Upgrading is as easy as upgrading the youckan package and rerunning the initialization: $ pip install -U youckan $ youckan init --noinput NGinx + uwsgi $ youckan genconf --nginx # or $ youckan genconf --nginx --uwsgi Apache 2 + mod $ youckan genconf --apache # or $ youckan genconf --apache --uwsgi 3.3 YouCKAN SSO 3.4 API 3.5 Contributing YouCKAN is open-source and very open to contributions YouCKAN SSO 9

14 3.5.1 Submitting issues Issues are contributions in a way so don t hesitate to submit reports on the official bugtracker. Provide as much informations as possible to specify the issues: the YouCKAN version used a stacktrace installed applications list Submitting patches (bugfix, features,...) If you want to contribute some code: 1. fork the official YouCKAN repository 2. create a branch with an explicit name (like my-new-feature or issue-xx) 3. do your work in it 4. rebase it on the master branch from the official repository (cleanup your history by performing an interactive rebase) 5. submit your pull-request There are some rules to follow: your contribution should be documented (if needed) your contribution should be tested and the test suite should pass successfully your code should be mostly PEP8 compatible with a 120 characters line length your contribution should support both Python 2 and 3 (use tox to test) You need to install some dependencies to hack on YouCKAN: $ pip install -r requirements/all.pip A fabfile is provided to simplify the common tasks: $ fab -l Available commands: coverage datamig debug dist doc gdist i18n i18n_build init mig pep8 pylint serve sso syncdb Run the test suite with coverage Generate a south data migration for an application Run Development server. Build a source distribution Generate the documentation. Build a source distribution with git version Generate translation files (.mo) Compile translation files (.po) Initialize database and user. Generate a south migration for an application Run the PEP8 report Run the pylint report Run Development server. Run Development server. Synchronize database and generate changesets 10 Chapter 3. Documentation

15 test test_all update update_js update_py work Run only project tests (exclude those from Django and third-party applications). Run all tests (including those from Django and third-party applications). Update all dependencies and database Update javascript dependencies Update python dependencies. Run the development worker To ensure everything is fine before submission, use tox. It will run the test suite on all the supported Python version and ensure the documentation is generating. $ tox You also need to ensure your code is PEP8 compliant (following the project rules: see pep8.rc file): $ fab pep8 Don t forget client-side code and tests. You can run the javascript test suite in the browser ( Note: minification use yuglify so you need to install it before: npm install -g yuglify 3.6 Changelog Current Nothing yet 3.6. Changelog 11

16 12 Chapter 3. Documentation

17 CHAPTER 4 Indices and tables genindex modindex search 13