Metadata-Version: 1.1
Name: dossier.store
Version: 0.3.5.dev1
Summary: Feature collection storage for DossierStack
Home-page: http://github.com/dossier/dossier.store
Author: Diffeo, Inc.
Author-email: support@diffeo.com
License: 
Copyright (c) 2012-2014 Diffeo, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

Description: `dossier.store` is a Python package that provides database storage for
        feature collections in DossierStack. It is built on top of `kvlayer`, so
        it supports many database backends like PostgreSQL, Accumulo and Redis.
        `dossier.store` also provides support for defining basic indexes.
        
        
        ### Installation
        
        `dossier.store` is on PyPI and can be installed with `pip`:
        
        ```bash
        pip install dossier.store
        ```
        
        Currently, `dossier.store` requires Python 2.7. It is not yet Python 3
        compatible.
        
        
        ### Documentation
        
        API documentation with examples is available as part of the Dossier Stack
        documentation:
        [http://dossier-stack.readthedocs.org](http://dossier-stack.readthedocs.org#module-dossier.store)
        
        
        ### Basic example
        
        A full working example that uses local memory to store a feature collection:
        
        ```python
        from dossier.fc import FeatureCollection
        from dossier.store import Store
        import kvlayer
        import yakonfig
        
        yaml = """
        kvlayer:
          app_name: store
          namespace: dossier
          storage_type: local
        """
        with yakonfig.defaulted_config([kvlayer], yaml=yaml):
            store = Store(kvlayer.client())
        
            fc = FeatureCollection({u'NAME': {'Foo': 1, 'Bar': 2}})
            store.put([('1', fc)])
            print store.get('1')
        ```
        
        
        ### Example using indexes
        
        Here is another example that demonstrates use of indexing to enable a
        poor man's case insensitive search:
        
        ```python
        fc = dossier.fc.FeatureCollection()
        fc[u'NAME'][u'foo'] += 1
        fc[u'NAME'][u'bar'] = 42
        
        kvl = kvlayer.client()
        store = dossier.store.Store(kvl)
        
        # Index transforms must be defined on every instance of `Store`.
        # (The index data is persisted; the transforms themselves are
        # ephemeral.)
        store.define_index(u'name_casei',
                           create=feature_index(u'NAME'),
                           transform=lambda s: s.lower().encode('utf-8'))
        
        store.put('{yourid}', fc)  # `put` automatically updates indexes.
        assert list(store.index_scan(u'name_casei', 'FoO'))[0] == '{yourid}'
        ```
        
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: MIT License
