Skip to content
This repository has been archived by the owner on Apr 30, 2021. It is now read-only.

User Defined Catalog #35

Closed
1 task
andersy005 opened this issue Jan 22, 2019 · 0 comments
Closed
1 task

User Defined Catalog #35

andersy005 opened this issue Jan 22, 2019 · 0 comments
Assignees

Comments

@andersy005
Copy link
Contributor

andersy005 commented Jan 22, 2019

Brainstorming

  • Create an abstract class representing a user defined catalog
class Catalog(object):
    """
    An abstract class representing a user defined Catalog.
    All user defined catalogs should subclass it. All subclasses should override
    ``build_catalog``, ``activate_catalog``, ``search``, ``get_files``, 
    """
    def build_catalog(self):
        """Builds catalog from a user defined YAML file"""
        raise NotImplementedError
        
    def activate_catalog(self):
        """Set the active catalog to work with"""
        raise NotImplementedError
        
    def search(self):
        """Find entries matching a query"""
        raise NotImplementedError
        
    def get_files(self):
        """Returns list of files matching a query"""
        raise NotImplementedError

Ccing @matt-long, let's discuss more about this.

@andersy005 andersy005 changed the title **User Defined Catalog** User Defined Catalog Jan 22, 2019
@andersy005 andersy005 self-assigned this Jan 22, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant