Remove prettyprinting unless DEBUG is set in env and add a new
[ckanext-ga-report.git] / README.rst
David Read 1 ckanext-ga-report
2 =================
3
4 **Status:** Development
5
6 **CKAN Version:** 1.7.1+
7
8
9 Overview
10 --------
11
12 For creating detailed reports of CKAN analytics, including totals per group.
13
14 Whereas ckanext-googleanalytics focusses on providing page view stats a recent period and for all time (aimed at end users), ckanext-ga-report is more interested in building regular periodic reports (more for site managers to monitor).
15
16 Contents of this extension:
17
18 * Use the CLI tool to download Google Analytics data for each time period into this extension's database tables
19
20 * Users can view the data as web page reports
21
22
23 Installation
24 ------------
25
26 1. Activate you CKAN python environment and install this extension's software::
27
28 $ pyenv/bin/activate
29 $ pip install -e git+https://github.com/okfn/ckanext-ga-report.git#egg=ckanext-ga-report
30
31 2. Ensure you development.ini (or similar) contains the info about your Google Analytics account and configuration::
32
33 googleanalytics.id = UA-1010101-1
Ross Jones 34 googleanalytics.username = googleaccount@gmail.com
David Read 35 googleanalytics.password = googlepassword
36 ga-report.period = monthly
Ross Jones 37
David Read 38 Note that your password will be readable by system administrators on your server. Rather than use sensitive account details, it is suggested you give access to the GA account to a new Google account that you create just for this purpose.
39
40 3. Set up this extension's database tables using a paster command. (Ensure your CKAN pyenv is still activated, run the command from ``src/ckanext-ga-report``, alter the ``--config`` option to point to your site config file)::
41
42 $ paster initdb --config=../ckan/development.ini
43
44 4. Enable the extension in your CKAN config file by adding it to ``ckan.plugins``::
45
46 ckan.plugins = ga-report
47
Ross Jones 48
49 Authorization
50 --------------
51
52 Before you can access the data, you need to set up the OAUTH details which you can do by following the `instructions <https://developers.google.com/analytics/resources/tutorials/hello-analytics-api>`_ the outcome of which will be a file called credentials.json which should look like credentials.json.template with the relevant fields completed. These steps are below for convenience:
53
54 1. Visit the `Google APIs Console <https://code.google.com/apis/console>`_
55
56 2. Sign-in and create a project or use an existing project.
57
58 3. In the `Services pane <https://code.google.com/apis/console#:services>`_ , activate Analytics API for your project. If prompted, read and accept the terms of service.
59
60 4. Go to the `API Access pane <https://code.google.com/apis/console/#:access>`_
61
62 5. Click Create an OAuth 2.0 client ID....
63
64 6. Fill out the Branding Information fields and click Next.
65
66 7. In Client ID Settings, set Application type to Installed application.
67
68 8. Click Create client ID
69
70 9. The details you need below are Client ID, Client secret, and Redirect URIs
71
72
73 Once you have set up your credentials.json file you can generate an oauth token file by using the
Ross Jones 74 following command, which will store your oauth token in a file called token.dat once you have finished
Ross Jones 75 giving permission in the browser::
76
77 $ paster getauthtoken --config=../ckan/development.ini
78
David Read 79
80 Tutorial
81 --------
Ross Jones 82
David Read 83 Download some GA data and store it in CKAN's db. (Ensure your CKAN pyenv is still activated, run the command from ``src/ckanext-ga-report``, alter the ``--config`` option to point to your site config file) and specifying the name of your auth file (token.dat by default) from the previous step::
Ross Jones 84
David Read 85 $ paster loadanalytics token.dat latest --config=../ckan/development.ini
Ross Jones 86
87 The value after the token file is how much data you want to retrieve, this can be
88
89 * **all** - data for all time (since 2010)
90
91 * **latest** - (default) just the 'latest' data
92
93 * **YYYY-MM-DD** - just data for all time periods going back to (and including) this date
94
David Read 95
96
97 Software Licence
98 ================
99
100 This software is developed by Cabinet Office. It is Crown Copyright and opened up under the Open Government Licence (OGL) (which is compatible with Creative Commons Attibution License).
101
102 OGL terms: http://www.nationalarchives.gov.uk/doc/open-government-licence/
103