Metadata-Version: 1.1
Name: ckanext-datastore-ts
Version: 0.1.1
Summary: Timeseries-based datastore extension
Home-page: https://github.com/namgk/ckanext-datastore_ts
Author: Nam Giang
Author-email: kyng@ece.ubc.ca
License: AGPL
Description: 
        =============
        ckanext-datastore_ts
        =============
        
        Timeseries data is streams of data that is indexed by timestamp, such as sensing data. Current default CKAN Datastore plugin only index data based on an auto-incremental integer with no support for timeseries data. Perceived that timeseries data is an important capability when working with sensor network, a new plugin that supports operations based on timestamp natively would be necessary. Thus, the purpose of this repository.
        
        ------------
        Changes
        ------------
        * If you are upgrading from version < 0.1.0, the schema has changed. A command has been created to upgrade the schema. Please run the following command:
        ```
        paster --plugin=ckan datastore_ts -c <path to ini configuration file> upgrade-schema autogen_timestamp _autogen_timestamp
        ```
        
        ------------
        Requirements
        ------------
        
        Being developed under CKAN 2.5.2
        
        Requires iso8601:
        
        ``` pip install iso8601 ```
        
        ------------
        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-datastore_ts:
        
        1. Activate your CKAN virtual environment, for example::
        
             . /usr/lib/ckan/default/bin/activate
        
        2. Install the ckanext-datastore_ts Python package into your virtual environment::
        
             pip install ckanext-datastore_ts
        
        3. Add ``datastore_ts`` 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
        ---------------
        Datastore_ts uses configurations from Datastore plugin so make sure those are set. In brief:
        
        sqlalchemy.url = postgresql://ckan_default:pass@localhost/ckan_default
        
        ckan.datastore.write_url = postgresql://ckan_default:password@localhost/datastore_default
        
        ckan.datastore.read_url = postgresql://datastore_default:password@localhost/datastore_default
        
        
        ------------------------
        Development Installation
        ------------------------
        
        To install ckanext-datastore_ts for development, activate your CKAN virtualenv and
        do::
        
            git clone https://github.com/namgk/ckanext-datastore_ts.git
            cd ckanext-datastore_ts
            python setup.py develop
            pip install -r dev-requirements.txt
        
        
        -----------------
        Running the Tests
        -----------------
        
        To run the tests, do::
        
            nosetests --nologcapture --ckan --with-pylons=test-core.ini ckanext/datastore_ts/tests/test.. .py
        
        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.datastore_ts --cover-inclusive --cover-erase --cover-tests
        
        
        ---------------------------------
        Registering ckanext-datastore_ts on PyPI
        ---------------------------------
        
        ckanext-datastore_ts should be availabe on PyPI as
        https://pypi.python.org/pypi/ckanext-datastore_ts. 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-datastore_ts
        ----------------------------------------
        
        ckanext-datastore_ts is availabe on PyPI as https://pypi.python.org/pypi/ckanext-datastore_ts.
        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
        
Keywords: CKAN
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
