ckanext-likes

This extension adds a Like functionality to your CKAN, users are able to likes datasets and their resource.

Requirements

NOTE: Extension is works on CKAN 2.9x if pulled from master branch.

Installation

To install ckanext-likes:

1. Activate your CKAN virtual environment, for example:

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

2. Install the ckanext-likes Python package into your virtual environment:

   pip install ckanext-likes
   

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

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

   sudo service apache2 reload
   

Development Installation

To install ckanext-likes for development, activate your CKAN virtualenv, make sure you are pulling from the right branch depending on what ckan version you are running. do:

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

Running the Tests

To run the tests, make sure you have your testing environment set up, to do so follow official CKAN testing documentation(https://docs.ckan.org/en/2.9/contributing/test.html), and make sure you have (pytest) and (pytest-ckan) installed.

Then in your ckanext-likes directory do:

pytest --ckan-ini=test.ini --disable-pytest-warnings -v

To run the tests and produce a coverage report, run:

pytest --ckan-ini=test.ini --disable-pytest-warnings -v -cov

Registering ckanext-likes on PyPI

ckanext-likes should be availabe on PyPI as https://pypi.python.org/pypi/ckanext-likes. If that link doesn't work, then you can register the project on PyPI for the first time by following these steps:

1. Create a source distribution of the project:

   python setup.py sdist
   

2. Register the project:

   python setup.py register
   

3. Upload the source distribution to PyPI:

   python setup.py sdist upload
   

4. Tag the first 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
   

Releasing a New Version of ckanext-likes

ckanext-likes is availabe on PyPI as https://pypi.python.org/pypi/ckanext-likes. To publish a new version to PyPI follow these steps:

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

2. Create a source distribution of the new version:

   python setup.py sdist
   

3. Upload the source distribution to PyPI:

   python setup.py sdist upload
   

4. 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.2 then do:

   git tag 0.0.2
   git push --tags