Metadata-Version: 1.1
Name: datapackage-registry
Version: 0.1.3
Summary: A Python library for working with a Data Package Registry.
Home-page: https://github.com/okfn/datapackage-registry-py
Author: Open Knowledge Foundation
Author-email: info@okfn.org
License: MIT
Description: |Build Status| |Coverage Status|
        
        datapackage-registry-py
        =======================
        
        A Python library for working with a Data Package Registry.
        
        Currently, the default registry backend is currently located at:
        https://rawgit.com/dataprotocols/registry/master/registry.csv
        
        Usage
        -----
        
        .. code:: python
        
            import datapackage_registry
        
            # get the default registry objects
            registry = datapackage_registry.Registry()
        
            # see the available profiles in the registry
            print(registry.available_profiles)
            # {
            #     'base': {
            #         'id': 'base',
            #         'schema': 'https://rawgit.com/dataprotocols/schemas/master/data-package.json',
            #         'specification': 'http://dataprotocols.org/data-packages',
            #         'title': 'Data Package'
            #     },
            #     'tabular': {
            #         'id': 'tabular',
            #         'schema': 'https://rawgit.com/dataprotocols/schemas/master/tabular-data-package.json',
            #         'specification': 'http://dataprotocols.org/tabular-data-package/',
            #         'title': 'Tabular Data Package'
            #    }
            # }
        
            # get a profile by its id
            base_profile = registry.get('base')
        
        If you’d like to use a custom registry, you can pass its URL or local
        path to the ``Registry()`` constructor, as in:
        
        .. code:: python
        
            import datapackage_registry
        
            registry = datapackage_registry.Registry('http://someplace.com/my-registry.csv')
        
        Developer notes
        ---------------
        
        These notes are intended to help people that want to contribute to this
        package itself. If you just want to use it, you can safely ignore this.
        
        Upgrading the local schemas cache
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        We cache the schemas from https://github.com/dataprotocols/schemas using
        git-subtree. To update it, use:
        
        ::
        
            git subtree pull --prefix datapackage_registry/schemas https://github.com/dataprotocols/schemas.git master --squash
        
        .. |Coverage Status| image:: https://coveralls.io/repos/okfn/datapackage-registry-py/badge.svg?branch=master&service=github
           :target: https://coveralls.io/github/okfn/datapackage-registry-py?branch=master
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
