Theming extension for Montreal city.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
ckanext Bump Oct 3, 2018
.coveragerc Initial commit Aug 29, 2018
.gitignore Initial commit Aug 29, 2018
.travis.yml Initial commit Aug 29, 2018
LICENSE Initial commit Aug 29, 2018
MANIFEST.in Add .png Aug 29, 2018
README.rst Initial commit Aug 29, 2018
dev-requirements.txt Initial commit Aug 29, 2018
requirements.txt Initial commit Aug 29, 2018
setup.cfg Initial commit Aug 29, 2018
setup.py
test.ini Initial commit Aug 29, 2018

README.rst

https://travis-ci.org//ckanext-montreal.svg?branch=master Downloads Latest Version Supported Python versions Development Status License

ckanext-montreal

Requirements

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

Installation

To install ckanext-montreal:

  1. Activate your CKAN virtual environment, for example:

    . /usr/lib/ckan/default/bin/activate
    
  2. Install the ckanext-montreal Python package into your virtual environment:

    pip install ckanext-montreal
    
  3. Add montreal 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.montreal.some_setting = some_default_value

Development Installation

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

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

Registering ckanext-montreal on PyPI

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

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