Installation

Path variables used below: - $INSTALL_FOLDER (i.e. where CKAN is installed), e.g. /usr/lib/ckan/default - $CONFIG_FILE, e.g. /etc/ckan/default/development.ini

Installing from PyPI¶

pip install ckanext-twitter

Installing from source¶

Clone the repository into the src folder:

cd $INSTALL_FOLDER/src
git clone https://github.com/NaturalHistoryMuseum/ckanext-twitter.git

Activate the virtual env:
```
. $INSTALL_FOLDER/bin/activate
```

Install via pip:

pip install $INSTALL_FOLDER/src/ckanext-twitter

Installing in editable mode¶

Installing from a pyproject.toml in editable mode (i.e. pip install -e) requires setuptools>=64; however, CKAN 2.9 requires setuptools==44.1.0. See our CKAN fork for a version of v2.9 that uses an updated setuptools if this functionality is something you need.

Post-install setup¶

Add 'twitter' to the list of plugins in your $CONFIG_FILE:
```
ckan.plugins = ... twitter
```

Add a 'tweet' block to read_base.html:

{% block tweet %}
{{ super() }}
{% endblock %}

Optionally, override the styling of the block by creating an ajax_snippets/edit_tweet.html file.