tableschema-ckan-datastore 0.0.3b0

tableschema-ckan-datastore-py
=============================

| |Travis|
| |Coveralls|
| |PyPi|
| |Gitter|

Generate and load CKAN DataStore tables based on `Table
Schema <http://specs.frictionlessdata.io/table-schema/>`__ descriptors.

Features
--------

- implements ``tableschema.Storage`` interface

Getting Started
---------------

Installation
~~~~~~~~~~~~

The package use semantic versioning. It means that major versions could
include breaking changes. It's highly recommended to specify ``package``
version range in your ``setup/requirements`` file e.g.
``package>=1.0,<2.0``.

.. code:: bash

pip install tableschema-ckan-datastore

Examples
~~~~~~~~

Code examples in this readme requires Python 3.3+ interpreter. You could
see even more example in
`examples <https://github.com/frictionlessdata/tableschema-ckan-datastore-py/tree/master/examples>`__
directory.

When writing data, tableschema-ckan-datastore uses the `CKAN API
``datastore_upsert``
endpoint <https://ckan.readthedocs.io/en/latest/maintaining/datastore.html#ckanext.datastore.logic.action.datastore_upsert>`__
with the ``upsert`` method. This requires a unique key in the data
defined by a `Table Schema primary key
property <https://specs.frictionlessdata.io/table-schema/#primary-key>`__.
If your data has a primary key, you can use the ``table.save`` method:

.. code:: python

from tableschema import Table

# Load and save CKAN DataStore record
resource_id = 'bd79c992-40f0-454a-a0ff-887f84a792fb'
base_url = 'https://demo.ckan.org'
dataset_id = 'test-dataset-010203'
api_key = 'my-ckan-user-api-key'

table = Table('data.csv', schema='schema.json') # data.csv has primary keys
table.save(resource_id,
storage='ckan_datastore',
base_url=base_url,
dataset_id=dataset_id,
api_key=api_key)

If you need to define the method used to save data to the DataStore, you
can create the ``tableschema.Storage`` object directly and specify which
method parameter to use:

.. code:: python

import io
import json
from tabulator import Stream
from tableschema import Storage

# Load and save CKAN DataStore record
resource_id = 'bd79c992-40f0-454a-a0ff-887f84a792fb'
base_url = 'https://demo.ckan.org'
dataset_id = 'test-dataset-010203'
api_key = 'my-ckan-user-api-key'

schema = json.load(io.open('schema.json', encoding='utf-8'))
data = Stream('data.csv', headers=1).open()

storage = Storage.connect('ckan_datastore',
base_url=base_url,
dataset_id=dataset_id,
api_key=api_key)
storage.create(resource_id, schema, force=True))
storage.write(resource_id, data, method='insert') # specify the datastore_upsert method

Documentation
-------------

The whole public API of this package is described here and follows
semantic versioning rules. Everything outside of this readme are private
API and could be changed without any notification on any new version.

Storage
~~~~~~~

Package implements `Tabular
Storage <https://github.com/frictionlessdata/tableschema-py#storage>`__
interface (see full documentation on the link):

|Storage|

This driver provides an additional API:

``Storage(base_url, dataset_id=None, api_key=None)``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

- ``base_url (str)`` - the base url (and scheme) for the CKAN instance
(e.g. http://demo.ckan.org).
- ``dataset_id (str)`` - id or name of the CKAN dataset we wish to use
as the bucket source. If missing, all tables in the DataStore are
used.
- ``api_key (str)`` - either a CKAN user api key or, if in the format
``env:CKAN_API_KEY_NAME``, an env var that defines an api key.

Contributing
------------

The project follows the `Open Knowledge International coding
standards <https://github.com/okfn/coding-standards>`__.

Recommended way to get started is to create and activate a project
virtual environment.

To install package and development dependencies into active environment:

::

$ make install

To run tests with linting and coverage:

.. code:: bash

$ make test

| For linting ``pylama`` configured in ``pylama.ini`` is used. On this
stage it's already
| installed into your environment and could be used separately with more
fine-grained control
| as described in documentation -
https://pylama.readthedocs.io/en/latest/.

For example to sort results by error type:

.. code:: bash

$ pylama --sort <path>

| For testing ``tox`` configured in ``tox.ini`` is used.
| It's already installed into your environment and could be used
separately with more fine-grained control as described in documentation
- https://testrun.org/tox/latest/.

| For example to check subset of tests against Python 2 environment with
increased verbosity.
| All positional arguments and options after ``--`` will be passed to
``py.test``:

.. code:: bash

tox -e py27 -- -v tests/<path>

| Under the hood ``tox`` uses ``pytest`` configured in ``pytest.ini``,
``coverage``
| and ``mock`` packages. This packages are available only in tox
envionments.

Changelog
---------

Here described only breaking and the most important changes. The full
changelog and documentation for all released versions could be found in
nicely formatted `commit
history <https://github.com/frictionlessdata/tableschema-ckan-datastore-py/commits/master>`__.

v0.x
~~~~

Initial driver implementation.

.. |Travis| image:: https://img.shields.io/travis/frictionlessdata/tableschema-ckan-datastore-py/master.svg
:target: https://travis-ci.org/frictionlessdata/tableschema-ckan-datastore-py
.. |Coveralls| image:: http://img.shields.io/coveralls/frictionlessdata/tableschema-ckan-datastore-py/master.svg
:target: https://coveralls.io/r/frictionlessdata/tableschema-ckan-datastore-py?branch=master
.. |PyPi| image:: https://img.shields.io/pypi/v/tableschema-ckan-datastore.svg
:target: https://pypi-hypernode.com/pypi/tableschema-ckan-datastore
.. |Gitter| image:: https://img.shields.io/gitter/room/frictionlessdata/chat.svg
:target: https://gitter.im/frictionlessdata/chat
.. |Storage| image:: https://i.imgur.com/RQgrxqp.png