Skip to content

Latest commit

 

History

History
201 lines (129 loc) · 5.54 KB

README.rst

File metadata and controls

201 lines (129 loc) · 5.54 KB
Raw
https://travis-ci.org//ckanext-tdp.svg?branch=master Downloads Latest Version Supported Python versions Development Status License

ckanext-tdp

Requirements

For example, you might want to mention here which versions of CKAN this extension works with.

Installation

To install ckanext-tdp:

  1. Activate your CKAN virtual environment, for example:

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

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

    pip install ckanext-tdp

  3. Add tdp 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

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.tdp.some_setting = some_default_value

Development Installation

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

git clone https://github.com//ckanext-tdp.git
cd ckanext-tdp
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.tdp --cover-inclusive --cover-erase --cover-tests

Registering ckanext-tdp on PyPI

ckanext-tdp should be availabe on PyPI as https://pypi.python.org/pypi/ckanext-tdp. 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-tdp

ckanext-tdp is availabe on PyPI as https://pypi.python.org/pypi/ckanext-tdp. 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

Overwrites for the default CKAN instance to provide custom styling.

Modular CSS architecture is used, loosely based on SMACSS(https://smacss.com/) Using PostCSS(https://github.com/postcss/postcss) and the Post CSS CLI(https://www.npmjs.com/package/postcss-cli).

Developing

CSS and Styles Navigate to the public folder docker-ckan/src/ckanext-tdp/ckanext/tdp/public

Run npm install

To build the CSS use npm run build

To watch the CSS for changes and automatically trigger a build, use npm run watch

PostCSS Is using Sugarss syntax https://github.com/postcss/sugarss and linted with stylelint https://github.com/stylelint/stylelint Source mapping is enabled to assist with debugging - this will be built with the CSS.

Contributing

Navigate to the public folder docker-ckan/src/ckanext-tdp/ckanext/tdp/public Run npm run lint - ensure no errors are produced before committing work.