{ "info": { "author": "mattRedBox", "author_email": "matt@redboxresearchdata.com.au", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)", "Programming Language :: Python :: 2.7" ], "description": ".. You should enable this project on travis-ci.org and coveralls.io to make\n these badges work. The necessary Travis and Coverage config files have been\n generated for you.\n\n.. image:: https://travis-ci.org/mattRedBox/ckanext-odi_certificates_client.svg?branch=master\n :target: https://travis-ci.org/mattRedBox/ckanext-odi_certificates_client\n\n.. image:: https://coveralls.io/repos/mattRedBox/ckanext-odi_certificates_client/badge.svg\n :target: https://coveralls.io/r/mattRedBox/ckanext-odi_certificates_client\n\n.. image:: https://pypip.in/download/ckanext-odi_certificates_client/badge.svg\n :target: https://pypi.python.org/pypi//ckanext-odi_certificates_client/\n :alt: Downloads\n\n.. image:: https://pypip.in/version/ckanext-odi_certificates_client/badge.svg\n :target: https://pypi.python.org/pypi/ckanext-odi_certificates_client/\n :alt: Latest Version\n\n.. image:: https://pypip.in/py_versions/ckanext-odi_certificates_client/badge.svg\n :target: https://pypi.python.org/pypi/ckanext-odi_certificates_client/\n :alt: Supported Python versions\n\n.. image:: https://pypip.in/status/ckanext-odi_certificates_client/badge.svg\n :target: https://pypi.python.org/pypi/ckanext-odi_certificates_client/\n :alt: Development Status\n\n.. image:: https://pypip.in/license/ckanext-odi_certificates_client/badge.svg\n :target: https://pypi.python.org/pypi/ckanext-odi_certificates_client/\n :alt: License\n\n=============\nckanext-odi_certificates_client\n=============\n\nAn API client for use with odi certificate server requests\n\n\n\n\n------------\nRequirements\n------------\n\nTested against: Ckan API 2.7.3\n(See requirements.txt)\n\n\n------------\nInstallation\n------------\n\n.. Add any additional install steps to the list below.\n For example installing any non-Python dependencies or adding any required\n config settings.\n\nTo install ckanext-odi_certificates_client:\n\n1. Activate your CKAN virtual environment, for example::\n\n . /usr/lib/ckan/default/bin/activate\n\n2. Install the ckanext-odi_certificates_client Python package into your virtual environment (pending)::\n\n pip install ckanext-odi_certificates_client\n\n3. Add ``odi_certificates_client`` to the ``ckan.plugins`` setting in your CKAN\n config file (by default the config file is located at\n ``/etc/ckan/default/production.ini``).\n\n4. Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu::\n\n sudo service apache2 reload\n\n\n---------------\nConfig Settings\n---------------\n\n Config required to communicate with any odi certificate server (values are examples only)\n\n - (**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::\n \n ``ckan.site.alias_url = http://alias_site_url:5000``\n \n - (**REQUIRED**) Base url for the odi certificate server\n\n ``ckanext.odi_certificates.server = http://myodicertificateserver:3000``\n \n - (**REQUIRED**) Username (usually in email form) for an odi certificate server admin account\n\n ``ckanext.odi_certificates.username = test@example.com``\n \n - (**REQUIRED**) An API token. The odi certificate server 'Account' page of any registered user will reveal their API key\n \n ``ckanext.odi_certificates.token = KASDFASDFXXXSed0e9fg``\n \n - (**REQUIRED**) Controls which specific survey is made available according to an odi jurisdiction/country survey\n \n ``ckanext.odi_certificates.jurisdiction = au``\n \n - (**REQUIRED**) locale enables odi certificate's i18n/internationalization support\n\n ``ckanext.odi_certificates.locale = en``\n\n\n\n\n\n------------------------\nDevelopment Installation\n------------------------\n\nTo install ckanext-odi_certificates_client for development, activate your CKAN virtualenv and\ndo::\n\n git clone https://github.com/mattRedBox/ckanext-odi_certificates_client.git\n cd ckanext-odi_certificates_client\n python setup.py develop\n pip install -r dev-requirements.txt\n\n\n-----------------\nRunning the Tests\n-----------------\n\nTo run the tests, do::\n\n nosetests --nologcapture --with-pylons=test.ini\n\nTo run the tests and produce a coverage report, first make sure you have\ncoverage installed in your virtualenv (``pip install coverage``) then run::\n\n nosetests --nologcapture --with-pylons=test.ini --with-coverage --cover-package=ckanext.odi_certificates_client --cover-inclusive --cover-erase --cover-tests\n\n\n---------------------------------\nRegistering ckanext-odi_certificates_client on PyPI\n---------------------------------\n\nckanext-odi_certificates_client should be availabe on PyPI as\nhttps://pypi.python.org/pypi/ckanext-odi_certificates_client. If that link doesn't work, then\nyou can register the project on PyPI for the first time by following these\nsteps:\n\n1. Create a source distribution of the project::\n\n python setup.py sdist\n\n2. Register the project::\n\n python setup.py register\n\n3. Upload the source distribution to PyPI::\n\n python setup.py sdist upload\n\n4. Tag the first release of the project on GitHub with the version number from\n the ``setup.py`` file. For example if the version number in ``setup.py`` is\n 0.0.1 then do::\n\n git tag 0.0.1\n git push --tags\n\n\n----------------------------------------\nReleasing a New Version of ckanext-odi_certificates_client\n----------------------------------------\n\nckanext-odi_certificates_client is availabe on PyPI as https://pypi.python.org/pypi/ckanext-odi_certificates_client.\nTo publish a new version to PyPI follow these steps:\n\n1. Update the version number in the ``setup.py`` file.\n See `PEP 440 `_\n for how to choose version numbers.\n\n2. Create a source distribution of the new version::\n\n python setup.py sdist\n\n3. Upload the source distribution to PyPI::\n\n python setup.py sdist upload\n\n4. Tag the new release of the project on GitHub with the version number from\n the ``setup.py`` file. For example if the version number in ``setup.py`` is\n 0.0.2 then do::\n\n git tag 0.0.2\n git push --tags\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/mattRedBox/ckanext-odi_certificates_client", "keywords": "CKAN ODI-Queensland QCIF certificates open-data-certificate", "license": "AGPL", "maintainer": "", "maintainer_email": "", "name": "ckanext-odi_certificates_client", "package_url": "https://pypi.org/project/ckanext-odi_certificates_client/", "platform": "", "project_url": "https://pypi.org/project/ckanext-odi_certificates_client/", "project_urls": { "Homepage": "https://github.com/mattRedBox/ckanext-odi_certificates_client" }, "release_url": "https://pypi.org/project/ckanext-odi_certificates_client/1.0.0/", "requires_dist": null, "requires_python": "", "summary": "A client for open data certificate server.", "version": "1.0.0" }, "last_serial": 4291083, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "523fc14174248ff84aacb55367f356cb", "sha256": "c66cb3f14dfefd22e40ad85aa199f0e5676278acbd8595a8a610b751145a464b" }, "downloads": -1, "filename": "ckanext-odi_certificates_client-1.0.0.tar.gz", "has_sig": false, "md5_digest": "523fc14174248ff84aacb55367f356cb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 22255, "upload_time": "2018-09-20T03:34:08", "url": "https://files.pythonhosted.org/packages/a7/62/3b5618384a198b722a5e41063b2354e0d9bec71d968a1ea2dbc5d6223ef0/ckanext-odi_certificates_client-1.0.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "523fc14174248ff84aacb55367f356cb", "sha256": "c66cb3f14dfefd22e40ad85aa199f0e5676278acbd8595a8a610b751145a464b" }, "downloads": -1, "filename": "ckanext-odi_certificates_client-1.0.0.tar.gz", "has_sig": false, "md5_digest": "523fc14174248ff84aacb55367f356cb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 22255, "upload_time": "2018-09-20T03:34:08", "url": "https://files.pythonhosted.org/packages/a7/62/3b5618384a198b722a5e41063b2354e0d9bec71d968a1ea2dbc5d6223ef0/ckanext-odi_certificates_client-1.0.0.tar.gz" } ] }