https://github.com/datopian/ckanext-opendatani
https://github.com/datopian/ckanext-opendatani
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/datopian/ckanext-opendatani
- Owner: datopian
- License: agpl-3.0
- Created: 2015-07-17T08:45:21.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2025-09-02T12:01:39.000Z (7 months ago)
- Last Synced: 2025-09-02T14:15:39.998Z (7 months ago)
- Language: Python
- Size: 707 KB
- Stars: 4
- Watchers: 27
- Forks: 5
- Open Issues: 7
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
==================
ckanext-opendatani
==================
A CKAN extension for Open Data NI.
------------
Requirements
------------
* `ckanext-showcase `_: add ``showcase`` to ``ckan.plugins``
* `ckanext-scheming `_: add ``scheming_datasets`` to ``ckan.plugins``
* `ckanext-datarequests (Viderum fork) `_: add ``datarequests`` to ``ckan.plugins``
* `ckanext-contact `_: add ``contact`` to ``ckan.plugins``
* `ckanext-disqus `_: add ``disqus`` to ``ckan.plugins``
* `ckanext-pages `_: add ``pages`` to ``ckan.plugins``
------------
Installation
------------
.. Add any additional install steps to the list below.
For example installing any non-Python dependencies or adding any required
config settings.
To install ckanext-opendatani:
1. Activate your CKAN virtual environment, for example::
. /usr/lib/ckan/default/bin/activate
2. Install the ckanext-opendatani Python package into your virtual environment::
pip install ckanext-opendatani
3. Add ``opendatani`` 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.opendatani.some_setting = some_default_value
------------------------
Development Installation
------------------------
To install ckanext-opendatani for development, activate your CKAN virtualenv and
do::
git clone https://github.com//ckanext-opendatani.git
cd ckanext-opendatani
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.opendatani --cover-inclusive --cover-erase --cover-tests
--------------------------------------
Registering ckanext-opendatani on PyPI
--------------------------------------
ckanext-opendatani should be availabe on PyPI as
https://pypi.python.org/pypi/ckanext-opendatani. 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-opendatani
---------------------------------------------
ckanext-opendatani is availabe on PyPI as https://pypi.python.org/pypi/ckanext-opendatani.
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