Memopol Documentation

Transcription

1 Memopol Documentation Release Laurent Peuch, Mindiell, Arnaud Fabre January 26, 2016

2

3 Contents 1 User guide Authentication in the admin backend Managing representative positions Managing vote recommendations Data updates Deployment on OpenShift Clone the repository Create an app on OpenShift Add the git remote created by OpenShift Activate OpenShift s git post-recieve hook Deploy your branch Data provisionning Administrator guide Authentication in the admin backend User groups Creating a user Local development tutorial Make a virtual environment Clone the repository Install Python dependencies Install client dependencies Activate DJANGO_DEBUG Run the development server Database migrations Provision with data Hacker guide Adding random recommendations Creating test fixtures Indices and tables 15 i

4 ii

5 Memopol Documentation, Release Contents: Contents 1

6 Memopol Documentation, Release Contents

7 CHAPTER 1 User guide 1.1 Authentication in the admin backend As a content-editor, you should be able to connect to the administration interface with the credentials and link that your administrator sent you. If they haven t, please them with a request and eventually a link to Administrator guide. 1.2 Managing representative positions Our dear representatives make promises to be elected. These can be submitted by visitors on the front-end so one of your tasks is to review them and publish them if they are appropriate. In Positions -> Position -> Change (url should be /admin/positions/position/), above the list table, click the Published select box and choose the Published: No option, then click Search. Alternatively, you may bookmark /admin/positions/position/?published exact=0. Click a Position and if it s appropriate then check the Published checkbox and click Save. The position will now appear in the representative detail page. 1.3 Managing vote recommendations A recommendation represents the vote we want representatives to make on a proposal: representatives doing the recommended vote will have their score increased, others will have their score decreased. Some recommendations may be more important than others, you can change the number of score points a recommendation is worth by changing its weight (must be a positive integer). In Votes -> Recommendations -> Change (url should be /admin/votes/recommendation/), you can create, update or remove recommendations. Your change won t be visible on score as soon as you make it. 1.4 Data updates Data updates daily: representatives details are updated daily, 3

8 Memopol Documentation, Release dossiers are synchronised daily, proposals are synchronised daily, when proposals are synchronised, they become available to use in Recommendations. votes and scores are synchronised daily for proposals which have a Recommendation, This means that if a proposal arrives today in the database, you may add a recommendation for it. The next day, votes will be imported and scores will be updated as well. 4 Chapter 1. User guide

9 CHAPTER 2 Deployment on OpenShift OpenShift is an Open-Source Platform-as-a-Service software by Red Hat. It is also available in its hosted version known as OpenShift Online and the first three websites ( gears ) are free. 2.1 Clone the repository You should fork the project on github and use the fork s clone url. For the sake of the demo, we ll use the main repository URL: $ git clone Cloning into 'political_memory'... remote: Counting objects: 2516, done. remote: Compressing objects: 100% (109/109), done. remote: Total 2516 (delta 44), reused 0 (delta 0), pack-reused 2402 Receiving objects: 100% (2516/2516), 4.40 MiB KiB/s, done. Resolving deltas: 100% (1103/1103), done. Checking connectivity... done. $ cd political_memory/ Create your own branch, ie: $ git checkout -b yourbranch origin/pr Branch yourbranch set up to track remote branch pr from origin. Switched to a new branch 'yourbranch' 2.2 Create an app on OpenShift To deploy the website, use a command like: $ rhc app-create \ python-2.7 \ cron-1.4 \ postgresql-9.2 \ -a yourappname \ -e OPENSHIFT_PYTHON_WSGI_APPLICATION=memopol/wsgi.py \ --from-code \ --no-git 5

10 Memopol Documentation, Release This should create an app on openshift. Other commands would deploy it at once but in this tutorial we re going to see how to manage it partly manually for development. 2.3 Add the git remote created by OpenShift Add the git remote openshift created for you, you can see it with rhc app-show, ie.: $ rhc app-show -a yourappname [snip] Git URL: ssh://569f5cf500045f6a1839a0a4@yourappname-yourdomain.rhcloud.com/~/git/yourappname. Initial Git URL: SSH: 569f5cf500045f6a1839a0a4@yourappname-yourdomain.rhcloud.com [snip] $ git remote add oo_yourappname ssh://569f5cf500045f6a1839a0a4@yourappname-yourdomain.rhcloud.com/~/g 2.4 Activate OpenShift s git post-recieve hook Activate OpenShift s post-receive hook on your branch: $ rhc app-configure -a yourappname --deployment-branch yourbranch 2.5 Deploy your branch OpenShift will deploy when it receives commits on the deployment branch, to deploy just do: $ git push oo_yourappname yourbranch If something goes wrong and you want to retry, use the rhc app-deploy command, ie: $ rhc app-deploy yourbranch -a yourappname 2.6 Data provisionning To fill up the representatives database table, either wait for the cron script to be executed, either do it manually: $ rhc ssh -a yourappname 'cd app-root/repo/ && bin/update_all' OpenShift is fun, login with ssh and look around if you re curious, you ll be able to recreate your app without much effort if you break it anyway. Continue to Administrator guide. 6 Chapter 2. Deployment on OpenShift

11 CHAPTER 3 Administrator guide This guide targets the administrator who has deployed the website in production. 3.1 Authentication in the admin backend If you haven t already, create a super-administrator account with command:./manage.py createsuperuser Then use this account to authenticate in the administration backend located in /admin. 3.2 User groups You should create a user group with all permissions on: vote recommendation positions position 3.3 Creating a user To create a content administrator, create a user with: Staff status : checked, otherwise the user won t be able to authenticate in the administration backend, groups: at least the group created above. Then, send the credentials to the user along with a link to User guide. 7

12 Memopol Documentation, Release Chapter 3. Administrator guide

13 CHAPTER 4 Local development tutorial This tutorial drives through a local installation of the project for development on Linux. It requires git, a fairly recent version of nodejs (see.openshift/action_hooks/deploy for a way to install it), python2 and virtualenv. 4.1 Make a virtual environment For the sake of the tutorial, we ll do this in the temporary directory, but you could do it anywhere: $ cd /tmp Create a python virtual environment and activate it: $ virtualenv memopol_env Using real prefix '/usr' New python executable in memopol_env/bin/python2 Also creating executable in memopol_env/bin/python Installing setuptools, pip, wheel...done. $ source memopol_env/bin/activate 4.2 Clone the repository You should fork the project on github and use the fork s clone url. For the sake of the demo, we ll use the main repository URL: $ git clone Cloning into 'political_memory'... remote: Counting objects: 2516, done. remote: Compressing objects: 100% (109/109), done. remote: Total 2516 (delta 44), reused 0 (delta 0), pack-reused 2402 Receiving objects: 100% (2516/2516), 4.40 MiB KiB/s, done. Resolving deltas: 100% (1103/1103), done. Checking connectivity... done. $ cd political_memory/ Create your own branch, ie: 9

14 Memopol Documentation, Release $ git checkout -b yourbranch origin/pr Branch yourbranch set up to track remote branch pr from origin. Switched to a new branch 'yourbranch' 4.3 Install Python dependencies Then, install the package for development: $ pip install -e. Obtaining file:///tmp/political_memory Collecting django (from political-memory==0.0.1) Using cached Django-1.9-py2.py3-none-any.whl [output snipped for readability] Installing collected packages: django, sqlparse, django-debug-toolbar, django-pdb, six, django-extens Running setup.py develop for political-memory Successfully installed django-1.9 django-coffeescript django-debug-toolbar-1.4 django-extension 4.4 Install client dependencies We ll also need to download client libraries: $ bin/install_client_deps.sh * Downloading jquery/jquery (2.1.4) from Github... * Downloading FortAwesome/Font-Awesome (v4.3.0) from Github... * Downloading lipis/flag-icon-css (0.7.1) from Github... * Downloading twbs/bootstrap (v3.3.5) from Github... * Done 4.5 Activate DJANGO_DEBUG DEBUG is disabled by default, the development server won t run properly by default thnen, to enable it export the DJANGO_DEBUG variable in the current shell: $ export DJANGO_DEBUG=True 4.6 Run the development server Run the development server: $./manage.py runserver Performing system checks... System check identified no issues (0 silenced). December 09, :26:47 Django version 1.8.7, using settings 'memopol.settings' Starting development server at 10 Chapter 4. Local development tutorial

15 Memopol Documentation, Release Quit the server with CONTROL-C. [09/Dec/ :26:48] "GET / HTTP/1.1" The website is running on Database migrations The repo comes with a pre-configured SQLite db with sample data so that you can start hacking right away. However, if you were to use a local postgresql database ie. with this sort of environment: export DJANGO_DATABASE_DEFAULT_NAME=memopol export DJANGO_DATABASE_DEFAULT_USER=postgres export DJANGO_DATABASE_DEFAULT_ENGINE=django.db.backends.postgresql_psycopg2 export DJANGO_DEBUG=1 export DJANGO_SETTINGS_MODULE=memopol.settings Then you could run database migrations: $./manage.py migrate Operations to perform: Synchronize unmigrated apps: django_filters, staticfiles, datetimewidget, autocomplete_light, messa Apply all migrations: legislature, votes, database, admin, positions, sessions, representatives, au Synchronizing apps without migrations: Creating tables... Running deferred SQL... Installing custom SQL... Running migrations: Rendering model states... DONE Applying contenttypes.0001_initial... OK [output snipped for readability] Applying taggit.0002_auto_ _ OK 4.8 Provision with data Again, the repo comes with a pre-configured SQLite db with sample data so that you can start hacking right away. However, you could still reload sample data: $./manage.py loaddata memopol/fixtures/small_sample.json Or actual data (takes a while): $ bin/update_all Continue to Administrator guide Database migrations 11

16 Memopol Documentation, Release Chapter 4. Local development tutorial

17 CHAPTER 5 Hacker guide 5.1 Adding random recommendations $./manage.py shell In [1]: from representatives_votes.models import Proposal In [2]: from votes.models import Recommendation In [3]: import random In [4]: for p in Proposal.objects.all(): Recommendation.objects.create(proposal=p, recommendation='fo 5.2 Creating test fixtures The largest test fixtures are, the longer it takes to load them, the longer the test run is. To create test fixtures for representatives_positions, insert some Position objects, and reduce the database with:./manage.py remove_representatives_without_position./manage.py remove_groups_without_mandate./manage.py remove_countries_without_group For representatives_recommendations:./manage.py remove_proposals_without_recommendation./manage.py remove_dossiers_without_proposal./manage.py remove_representatives_without_vote./manage.py remove_groups_without_mandate./manage.py remove_countries_without_group 13

18 Memopol Documentation, Release Chapter 5. Hacker guide

19 CHAPTER 6 Indices and tables genindex modindex search 15