ckanext-usertracking

TODO: Put a description of your extension here: What does it do? What features does it have? Consider including some screenshots or embedding a video!

The user tracking plugin adds an Activity tracking tab in the CKAN admin page to show engagement/activity data.

The plugin serves as an MVC for displaying 3 tables which inform of the user, organisational and individual-page engagement.

This necessitates the creation of the table user_activity_tracker which is populated via JS embedded in all CKAN pages which send POST request to the usertracking middleware.

The plugin also provides a CLI command to export the last x days of user_activity_tracker into a CSV.

Requirements

If your extension works across different versions you can add the following table:

Compatibility with core CKAN versions:

CKAN version	Compatible?
2.6 and earlier	not tested
2.7	not tested
2.8	not tested
2.9	yes

Suggested values:

• "yes"
• "not tested" - I can't think of a reason why it wouldn't work
• "not yet" - there is an intention to get it working
• "no"

Installation

TODO: Add any additional install steps to the list below. For example installing any non-Python dependencies or adding any required config settings.

To install ckanext-usertracking:

1. Activate your CKAN virtual environment, for example:

   . /usr/lib/ckan/default/bin/activate

2. Clone the source and install it on the virtualenv

   git clone https://gitlab.stfc.ac.uk/smdh/AEP/ckanext-usertracking cd ckanext-usertracking pip install -e . pip install -r requirements.txt

3. Add usertracking to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/ckan.ini).

4. Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu:

   sudo service apache2 reload

Config settings

None at present.

TODO: Document any optional config settings here. For example:

# The minimum number of hours to wait before re-checking a resource
# (optional, default: 24).
ckanext.usertracking.some_setting = some_default_value

Developer installation

To install ckanext-usertracking for development, activate your CKAN virtualenv and do:

git clone https://github.com/.../ckanext-usertracking.git
cd ckanext-usertracking
python setup.py develop
pip install -r dev-requirements.txt

ckan  -c /etc/ckan/default/ckan.ini usertracking export usertracking.csv

Tests

To run the tests, do:

pytest --ckan-ini=test.ini

TODO Review the new release workflow instead of below template.

Releasing a new version of ckanext-usertracking

If ckanext-usertracking should be available on PyPI you can follow these steps to publish a new version:

1. Update the version number in the setup.py file. See PEP 440 for how to choose version numbers.

2. Make sure you have the latest version of necessary packages:

   pip install --upgrade setuptools wheel twine

3. Create a source and binary distributions of the new version:

   python setup.py sdist bdist_wheel && twine check dist/*
   

   Fix any errors you get.

4. Upload the source distribution to PyPI:

   twine upload dist/*
   

5. Commit any outstanding changes:

   git commit -a
   git push
   

6. Tag the new release of the project on GitHub with the version number from the setup.py file. For example if the version number in setup.py is 0.0.1 then do:

   git tag 0.0.1
   git push --tags
   

License

AGPL