Merge branch 'master' into enhancement-2251-tracking
This commit is contained in:
commit
02644f1d2d
42
README.rst
42
README.rst
|
@ -25,15 +25,28 @@ Installation
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
$ pip install -e hg+http://github.com/okfn/ckanext-googleanalytics.git#egg=ckanext-googleanalytics
|
$ pip install -e git+https://github.com/okfn/ckanext-googleanalytics.git#egg=ckanext-googleanalytics
|
||||||
|
|
||||||
2. Run the following command from ``src/ckanext-googleanalytics`` to
|
2. Edit your development.ini (or similar) to provide these necessary parameters:
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
googleanalytics.id = UA-1010101-1
|
||||||
|
googleanalytics.username = googleaccount@gmail.com
|
||||||
|
googleanalytics.password = googlepassword
|
||||||
|
|
||||||
|
Note that your password will probably be readable by other people;
|
||||||
|
so you may want to set up a new gmail account specifically for
|
||||||
|
accessing your gmail profile.
|
||||||
|
|
||||||
|
|
||||||
|
3. Run the following command from ``src/ckanext-googleanalytics`` to
|
||||||
set up the required database tables (of course, altering the
|
set up the required database tables (of course, altering the
|
||||||
``--config`` option to point to your site config file)::
|
``--config`` option to point to your site config file)::
|
||||||
|
|
||||||
paster initdb --config=../ckan/development.ini
|
paster initdb --config=../ckan/development.ini
|
||||||
|
|
||||||
3. Edit your development.ini (or similar) to activate the extension
|
4. Edit again your configuration ini file to activate the extension
|
||||||
with:
|
with:
|
||||||
|
|
||||||
::
|
::
|
||||||
|
@ -43,17 +56,6 @@ Installation
|
||||||
(If there are other plugins activated, add this to the list. Each
|
(If there are other plugins activated, add this to the list. Each
|
||||||
plugin should be separated with a space)
|
plugin should be separated with a space)
|
||||||
|
|
||||||
In the same file, configure the plugin with your analytics details:
|
|
||||||
|
|
||||||
::
|
|
||||||
|
|
||||||
googleanalytics.id = UA-1010101-1
|
|
||||||
googleanalytics.username = googleaccount@gmail.com
|
|
||||||
googleanalytics.password = googlepassword
|
|
||||||
|
|
||||||
Note that your password will probably be readable by other people;
|
|
||||||
so you may want to set up a new gmail account specifically for
|
|
||||||
accessing your gmail profile.
|
|
||||||
|
|
||||||
Finally, there are some optional configuration settings (shown here
|
Finally, there are some optional configuration settings (shown here
|
||||||
with their default settings)::
|
with their default settings)::
|
||||||
|
@ -70,25 +72,25 @@ Installation
|
||||||
string, but should ideally resemble a URL path segment, to make
|
string, but should ideally resemble a URL path segment, to make
|
||||||
filtering for all resources easier in the Google Analytics web
|
filtering for all resources easier in the Google Analytics web
|
||||||
interface.
|
interface.
|
||||||
|
|
||||||
``domain`` allows you to specify a domain against which Analytics
|
``domain`` allows you to specify a domain against which Analytics
|
||||||
will track users. You will usually want to leave this as ``auto``;
|
will track users. You will usually want to leave this as ``auto``;
|
||||||
if you are tracking users from multiple subdomains, you might want
|
if you are tracking users from multiple subdomains, you might want
|
||||||
to specify something like ``.mydomain.com``. See `Google's
|
to specify something like ``.mydomain.com``. See `Google's
|
||||||
documentation <http://code.google.com/apis/analytics/docs/gaJS/gaJSApiDomainDirectory.html#_gat.GA_Tracker_._setDomainName>`_ for more info.
|
documentation <http://code.google.com/apis/analytics/docs/gaJS/gaJSApiDomainDirectory.html#_gat.GA_Tracker_._setDomainName>`_ for more info.
|
||||||
|
|
||||||
4. Restart CKAN (e.g. by restarting Apache)
|
5. Restart CKAN (e.g. by restarting Apache)
|
||||||
|
|
||||||
5. Wait a while for some stats to be recorded in Google
|
6. Wait a while for some stats to be recorded in Google
|
||||||
|
|
||||||
6. Import Google stats by running the following command from
|
7. Import Google stats by running the following command from
|
||||||
``src/ckanext-googleanalytics``::
|
``src/ckanext-googleanalytics``::
|
||||||
|
|
||||||
paster loadanalytics --config=../ckan/development.ini
|
paster loadanalytics --config=../ckan/development.ini
|
||||||
|
|
||||||
(Of course, pointing config at your specific site config)
|
(Of course, pointing config at your specific site config)
|
||||||
|
|
||||||
7. Look at some stats within CKAN
|
8. Look at some stats within CKAN
|
||||||
|
|
||||||
Once your GA account has gathered some data, you can see some basic
|
Once your GA account has gathered some data, you can see some basic
|
||||||
information about the most popular packages at:
|
information about the most popular packages at:
|
||||||
|
@ -98,7 +100,7 @@ Installation
|
||||||
website is on the package page, where number of downloads are
|
website is on the package page, where number of downloads are
|
||||||
displayed next to each resource.
|
displayed next to each resource.
|
||||||
|
|
||||||
8. Consider running the import command reguarly as a cron job, or
|
9. Consider running the import command reguarly as a cron job, or
|
||||||
remember to run it by hand, or your statistics won't get updated.
|
remember to run it by hand, or your statistics won't get updated.
|
||||||
|
|
||||||
Testing
|
Testing
|
||||||
|
|
|
@ -3,14 +3,14 @@
|
||||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||||
py:strip="">
|
py:strip="">
|
||||||
|
|
||||||
<py:def function="page_title">Google analytics for CKAN</py:def>
|
<py:def function="page_title">Analytics for ${g.site_title}</py:def>
|
||||||
|
|
||||||
<div py:match="content">
|
<div py:match="content">
|
||||||
|
|
||||||
<h2>Most viewed datasets</h2>
|
<h2>Most viewed datasets</h2>
|
||||||
<p><em>Note: this data does not include API calls</em></p>
|
<p><em>Note: this data does not include API calls</em></p>
|
||||||
|
|
||||||
<table>
|
<table class="table table-condensed table-bordered table-striped">
|
||||||
<tr>
|
<tr>
|
||||||
<th>Dataset</th>
|
<th>Dataset</th>
|
||||||
<th>Unique views (last 14 days)</th>
|
<th>Unique views (last 14 days)</th>
|
||||||
|
@ -27,7 +27,7 @@
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
<h2>Most downloaded resources</h2>
|
<h2>Most downloaded resources</h2>
|
||||||
<table>
|
<table class="table table-condensed table-bordered table-striped">
|
||||||
<tr>
|
<tr>
|
||||||
<th>Resource</th>
|
<th>Resource</th>
|
||||||
<th>Unique views (last 14 days)</th>
|
<th>Unique views (last 14 days)</th>
|
||||||
|
@ -35,7 +35,7 @@
|
||||||
</tr>
|
</tr>
|
||||||
<py:for each="resource, recent, ever in c.top_resources">
|
<py:for each="resource, recent, ever in c.top_resources">
|
||||||
<tr>
|
<tr>
|
||||||
<td>${h.link_to(resource.description or resource.format, resource.url)}<br />
|
<td>${h.link_to(h.truncate(resource.description, length=50,whole_word=True) if resource.description else resource.format, h.url_for(controller='package',action='resource_read',id=resource.resource_group.package.id,resource_id=resource.id))}<br />
|
||||||
<em>in ${h.link_to(resource.resource_group.package.title or resource.resource_group.package.name, h.url_for(controller='package', action='read', id=resource.resource_group.package.name))}</em>
|
<em>in ${h.link_to(resource.resource_group.package.title or resource.resource_group.package.name, h.url_for(controller='package', action='read', id=resource.resource_group.package.name))}</em>
|
||||||
</td>
|
</td>
|
||||||
<td>${recent}</td>
|
<td>${recent}</td>
|
||||||
|
|
Loading…
Reference in New Issue