Package: ckanext-odi_certificates_client
.. You should enable this project on travis-ci.org and coveralls.io to makethese badges work. The necessary Travis and Coverage config files have beengenerated for you... image:: https://travis-ci.org/mattRedBox/ckanext-odi_certificates_client.svg?branch=master:target: https://travis-ci.org/mattRedBox/ckanext-odi_certificates_client.. image:: https://coveralls.io/repos/mattRedBox/ckanext-odi_certificates_client/badge.svg:target: https://coveralls.io/r/mattRedBox/ckanext-odi_certificates_client.. image:: https://pypip.in/download/ckanext-odi_certificates_client/badge.svg:target: https://pypi.python.org/pypi//ckanext-odi_certificates_client/:alt: Downloads.. image:: https://pypip.in/version/ckanext-odi_certificates_client/badge.svg:target: https://pypi.python.org/pypi/ckanext-odi_certificates_client/:alt: Latest Version.. image:: https://pypip.in/py_versions/ckanext-odi_certificates_client/badge.svg:target: https://pypi.python.org/pypi/ckanext-odi_certificates_client/:alt: Supported Python versions.. image:: https://pypip.in/status/ckanext-odi_certificates_client/badge.svg:target: https://pypi.python.org/pypi/ckanext-odi_certificates_client/:alt: Development Status.. image:: https://pypip.in/license/ckanext-odi_certificates_client/badge.svg:target: https://pypi.python.org/pypi/ckanext-odi_certificates_client/:alt: License=============ckanext-odi_certificates_client=============An API client for use with odi certificate server requests------------Requirements------------Tested against: Ckan API 2.7.3(See requirements.txt)------------Installation------------.. Add any additional install steps to the list below.For example installing any non-Python dependencies or adding any requiredconfig settings.To install ckanext-odi_certificates_client:1. Activate your CKAN virtual environment, for example::. /usr/lib/ckan/default/bin/activate2. Install the ckanext-odi_certificates_client Python package into your virtual environment (pending)::pip install ckanext-odi_certificates_client3. Add ``odi_certificates_client`` to the ``ckan.plugins`` setting in your CKANconfig 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---------------Config required to communicate with any odi certificate server (values are examples only)- (**OPTIONAL**) When the odi certificate server tries to read urls from your ckan dataset, an alias/proxy may be needed for the odi certificate server to see your ckan datasets, whose records might use a URL not accessible by the odi certificate server::``ckan.site.alias_url = http://alias_site_url:5000``- (**REQUIRED**) Base url for the odi certificate server``ckanext.odi_certificates.server = http://myodicertificateserver:3000``- (**REQUIRED**) Username (usually in email form) for an odi certificate server admin account``ckanext.odi_certificates.username = test@example.com``- (**REQUIRED**) An API token. The odi certificate server 'Account' page of any registered user will reveal their API key``ckanext.odi_certificates.token = KASDFASDFXXXSed0e9fg``- (**REQUIRED**) Controls which specific survey is made available according to an odi jurisdiction/country survey``ckanext.odi_certificates.jurisdiction = au``- (**REQUIRED**) locale enables odi certificate's i18n/internationalization support``ckanext.odi_certificates.locale = en``------------------------Development Installation------------------------To install ckanext-odi_certificates_client for development, activate your CKAN virtualenv anddo::git clone https://github.com/mattRedBox/ckanext-odi_certificates_client.gitcd ckanext-odi_certificates_clientpython setup.py developpip install -r dev-requirements.txt-----------------Running the Tests-----------------To run the tests, do::nosetests --nologcapture --with-pylons=test.iniTo run the tests and produce a coverage report, first make sure you havecoverage installed in your virtualenv (``pip install coverage``) then run::nosetests --nologcapture --with-pylons=test.ini --with-coverage --cover-package=ckanext.odi_certificates_client --cover-inclusive --cover-erase --cover-tests---------------------------------Registering ckanext-odi_certificates_client on PyPI---------------------------------ckanext-odi_certificates_client should be availabe on PyPI ashttps://pypi.python.org/pypi/ckanext-odi_certificates_client. If that link doesn't work, thenyou can register the project on PyPI for the first time by following thesesteps:1. Create a source distribution of the project::python setup.py sdist2. Register the project::python setup.py register3. Upload the source distribution to PyPI::python setup.py sdist upload4. Tag the first release of the project on GitHub with the version number fromthe ``setup.py`` file. For example if the version number in ``setup.py`` is0.0.1 then do::git tag 0.0.1git push --tags----------------------------------------Releasing a New Version of ckanext-odi_certificates_client----------------------------------------ckanext-odi_certificates_client is availabe on PyPI as https://pypi.python.org/pypi/ckanext-odi_certificates_client.To publish a new version to PyPI follow these steps:1. Update the version number in the ``setup.py`` file.See `PEP 440 <http://legacy.python.org/dev/peps/pep-0440/#public-version-identifiers>`_for how to choose version numbers.2. Create a source distribution of the new version::python setup.py sdist3. Upload the source distribution to PyPI::python setup.py sdist upload4. Tag the new release of the project on GitHub with the version number fromthe ``setup.py`` file. For example if the version number in ``setup.py`` is0.0.2 then do::git tag 0.0.2git push --tags