Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Allows ckan to become an Oauth2 provider, letting other applications login through CKAN

Project Description
.. You should enable this project on travis-ci.org and coveralls.io to make
these badges work. The necessary Travis and Coverage config files have been
generated for you.

.. image:: https://travis-ci.org/dubvfan87/ckanext-oauth2provider.svg?branch=master
:target: https://travis-ci.org/dubvfan87/ckanext-oauth2provider

.. image:: https://coveralls.io/repos/dubvfan87/ckanext-oauth2provider/badge.svg
:target: https://coveralls.io/r/dubvfan87/ckanext-oauth2provider

.. image:: https://pypip.in/download/ckanext-oauth2provider/badge.svg
:target: https://pypi.python.org/pypi//ckanext-oauth2provider/
:alt: Downloads

.. image:: https://pypip.in/version/ckanext-oauth2provider/badge.svg
:target: https://pypi.python.org/pypi/ckanext-oauth2provider/
:alt: Latest Version

.. image:: https://pypip.in/py_versions/ckanext-oauth2provider/badge.svg
:target: https://pypi.python.org/pypi/ckanext-oauth2provider/
:alt: Supported Python versions

.. image:: https://pypip.in/status/ckanext-oauth2provider/badge.svg
:target: https://pypi.python.org/pypi/ckanext-oauth2provider/
:alt: Development Status

.. image:: https://pypip.in/license/ckanext-oauth2provider/badge.svg
:target: https://pypi.python.org/pypi/ckanext-oauth2provider/
:alt: License

=============
ckanext-oauth2provider
=============

.. Allows CKAN to become an OAuth2 provider.


------------
Requirements
------------

Requires CKAN v2.2 or greater

------------
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-oauth2provider:

1. Activate your CKAN virtual environment, for example::

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

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

pip install ckanext-oauth2provider

3. Add ``oauth2provider`` 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.oauth2provider.some_setting = some_default_value


------------------------
Development Installation
------------------------

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

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


---------------------------------
Registering ckanext-oauth2provider on PyPI
---------------------------------

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

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

Release History

This version
History Node

0.0.1

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting