Metadata-Version: 2.0
Name: udata-youckan
Version: 0.9.2.dev30
Summary: YouCKAN auth for uData
Home-page: https://github.com/etalab/udata-youckan
Author: Opendata Team
Author-email: opendatateam@data.gouv.fr
License: AGPL
Keywords: u,d,a,t,a, ,y,o,u,c,k,a,n, ,s,s,o, ,p,l,u,g,i,n
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python
Classifier: Environment :: Web Environment
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Topic :: System :: Software Distribution
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Requires-Dist: udata

uData-youckan
=============


.. image:: https://badges.gitter.im/Join%20Chat.svg
    :target: https://gitter.im/opendatateam/udata
    :alt: Join the chat at https://gitter.im/opendatateam/udata


This plugin provide integration between `uData`_ and `YouCKAN`_

Compatibility
-------------

**udata-youckan** requires Python 2.7+ and `uData`_.


Installation
------------

Install `uData`_.

Remain in the same virtual environment (for Python) and use the same version of npm (for JS).

Install **udata-youckan**:

.. code-block:: shell

    pip install udata-youckan



Configuration
-------------

In order to use YouCKAN as authentication provider, you need to enable the plugin
and add the following mandatory parameters to you uData configuration
(typically, `udata.cfg`) as following:

.. code-block:: python

    PLUGINS = ['youckan']
    YOUCKAN_URL = 'https://your.youckan.url/'
    YOUCKAN_CONSUMER_KEY = 'your-youckan-client-key',
    YOUCKAN_CONSUMER_SECRET = 'your-youckan-secret-key'



.. _circleci-url: https://circleci.com/gh/opendatateam/udata-youckan
.. _circleci-badge: https://circleci.com/gh/opendatateam/udata-youckan.svg?style=shield
.. _gitter-badge: https://badges.gitter.im/Join%20Chat.svg
.. _gitter-url: https://gitter.im/opendatateam/udata
.. _uData: https://github.com/opendatateam/udata
.. _YouCKAN: https://github.com/etalab/youckan

Changelog
=========

Current (in progress)
---------------------

- Nothing yet

0.9.1 (2017-01-10)
------------------

- Fix packaging

0.9.0 (2017-01-10)
------------------

- First published release



