3.4 KiB

Raw Permalink Blame History

ckanext-d4science_theme

The CKAN extension that implements the D4Science theme template used by D4Science Catalogues

Requirements

None

Installation

To install ckanext-d4science_theme:

Activate your CKAN virtual environment, for example:
```
. /usr/lib/ckan/default/bin/activate
```
Install the ckanext-d4science_theme Python package into your virtual environment:
```
pip install ckanext-d4science_theme
```
Add d4science_theme to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/production.ini).
Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu:
```
sudo service apache2 reload
```

Config Settings

Document any optional config settings here. For example:

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

Development Installation

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

git clone https://code-repo.d4science.org/CKAN-Extensions/ckanext-d4science_theme.git
cd ckanext-d4science_theme
python setup.py develop
pip install -r dev-requirements.txt

Running the Tests

To run the tests, do:

nosetests --nologcapture --with-pylons=test.ini

To run the tests and produce a coverage report, first make sure you have coverage installed in your virtualenv (pip install coverage) then run:

nosetests --nologcapture --with-pylons=test.ini --with-coverage --cover-package=ckanext.d4science_theme --cover-inclusive --cover-erase --cover-tests

---------------------------------Registering ckanext-d4science_theme on PyPI ---------------------------------

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

Create a source distribution of the project:
```
python setup.py sdist
```
Register the project:
```
python setup.py register
```
Upload the source distribution to PyPI:
```
python setup.py sdist upload
```
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-d4science_theme ----------------------------------------

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

Update the version number in the setup.py file. See PEP 440 for how to choose version numbers.
Create a source distribution of the new version:
```
python setup.py sdist
```
Upload the source distribution to PyPI:
```
python setup.py sdist upload
```
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
```