Metadata-Version: 2.1
Name: ckanext-fpx
Version: 0.2.3
Summary: UNKNOWN
Home-page: https://github.com/DataShades/ckanext-fpx
Author: Sergey Motornyuk
Author-email: sergey.motornyuk@linkdigital.com.au
License: AGPL
Keywords: CKAN
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/x-rst
Requires-Dist: six (>=1.13.0)


=============
ckanext-fpx
=============

CKAN adapter for FPX service


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

* Configured and running FPX


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

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

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

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

     pip install ckanext-fpx

3. Add ``fpx`` to the ``ckan.plugins`` setting in your CKAN
   config file (by default the config file is located at
   ``/etc/ckan/default/ckan.ini``).

4. Add ``fpx.client.secret`` and ``fpx.service.url`` config options

5. Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu::

     sudo service apache2 reload


---------------
Config settings
---------------

::

   # Client secret generated by FPX
   # (required).
   fpx.client.secret = 123abc

   # URL of the running FPX service
   # (required).
   fpx.service.url = http://0.0.0.0:8000


----------------------
Developer installation
----------------------

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

    git clone https://github.com/DataShades/ckanext-fpx.git
    cd ckanext-fpx
    python setup.py develop
    pip install -r dev-requirements.txt


-----
Tests
-----

To run the tests, do::

    pytest --ckan-ini=test.ini

To run the tests and produce a coverage report, first make sure you have
``pytest-cov`` installed in your virtualenv (``pip install pytest-cov``) then run::

    pytest --ckan-ini=test.ini  --cov=ckanext.fpx ckanext/fpx/tests


