clams-python 0.0.1__tar.gz → 0.0.1a1__tar.gz

{clams-python-0.0.1 → usr/local/anaconda3/envs/clamssdk/lib/python3.6/site-packages}/clams/__init__.py

@@ -1,7 +1,7 @@
+from clams.serialize import *
 from clams.serve import *
 from clams.restify import Restifier
-from mmif.serialize import *
-from mmif.vocab import *
+from clams.vocab import *
 
 
 

usr/local/anaconda3/envs/clamssdk/lib/python3.6/site-packages/clams/serialize/__init__.py

@@ -0,0 +1,173 @@
+import datetime
+import json
+
+
+class MmifObject(object):
+    def __init__(self, mmif_json=None):
+        if mmif_json is not None:
+            self.deserialize(mmif_json)
+
+    def serialize(self):
+        return self.__dict__
+
+    def deserialize(self, mmif):
+        raise NotImplementedError()
+
+    def __str__(self):
+        return json.dumps(self.serialize(), cls=MmifObjectEncoder)
+
+    def pretty(self):
+        return json.dumps(self, indent=2, cls=MmifObjectEncoder)
+
+
+class MmifObjectEncoder(json.JSONEncoder):
+    def default(self, obj):
+        if hasattr(obj, 'serialize'):
+            return obj.serialize()
+        elif hasattr(obj, '__str__'):
+            return str(obj)
+        else:
+            return json.JSONEncoder.default(self, obj)
+
+
+class Mmif(MmifObject):
+    context: str
+    metadata: dict
+    media: list
+    contains: dict
+    views: list
+
+    def __init__(self, mmif_json=None):
+        self.context = ''
+        self.metadata = {}
+        self.media = []
+        self.contains = {}
+        self.views = []
+        super().__init__(mmif_json)
+
+    def serialize(self):
+        d = self.__dict__.copy()
+        d['@context'] = d.pop('context')
+        return d
+
+    def deserialize(self, mmif):
+        in_json = json.loads(mmif)
+
+        # TODO (krim @ 10/3/2018): more robust json parsing
+        self.context = in_json["@context"]
+        self.contains = in_json["contains"]
+        self.metadata = in_json["metadata"]
+        self.media = in_json["media"]
+        self.views = in_json["views"]
+
+    def new_view_id(self):
+        return 'v_' + str(len(self.views))
+
+    def new_view(self):
+        new_view = View(self.new_view_id())
+        self.views.append(new_view)
+        return new_view
+
+    def add_media(self, medium):
+        try:
+            self.get_medium_location(medium)
+        # TODO (krim @ 10/7/2018): if get_m_location returns, raise "already exists" error
+        except Exception:
+            self.media.append(medium)
+
+    def get_medium_location(self, md_type):
+        for medium in self.media:
+            if medium["type"] == md_type:
+                return medium["location"]
+        raise Exception("{} type media not found".format(md_type))
+
+    def get_view_by_id(self, id):
+        for view in self.views:
+            if view['id'] == id:
+                return view
+        raise Exception("{} view not found".format(id))
+
+    def get_view_contains(self, attype):
+        return self.get_view_by_id(self.contains[attype])
+
+
+class Medium(MmifObject):
+    id: str
+    type: str
+    location: str
+    metadata: dict
+
+    def __init__(self, id, md_type='', uri=''):
+        self.id = id
+        self.type = md_type
+        self.location = uri
+        self.metadata = {}
+
+    def deserialize(self, mmif):
+        pass
+
+    def add_metadata(self, name, value):
+        self.metadata[name] = value
+
+
+class Annotation(MmifObject):
+    start: int
+    end: int
+    feature: dict
+    id: str
+    attype: str
+
+    def __init__(self, id, at_type=''):
+        # TODO (krim @ 10/4/2018): try deserialize "id", then if fails defaults to 0s
+        super().__init__()
+        self.start = 0
+        self.end = 0
+        self.feature = {}
+        self.id = id
+        self.attype = at_type
+
+    def deserialize(self, mmif):
+        pass
+
+    def add_feature(self, name, value):
+        self.feature[name] = value
+
+
+class View(MmifObject):
+    id: str
+    contains: dict
+    annotation: list
+
+    def __init__(self, id="UNIDENTIFIED"):
+        super().__init__()
+        self.id = id
+        self.contains = {}
+        self.annotations = []
+
+    def deserialize(self, view):
+        pass
+
+    def new_contain(self, at_type, producer=""):
+        new_contain = Contain()
+        new_contain.gen_time = datetime.datetime.utcnow().isoformat()
+        self.contains[at_type] = new_contain
+        return new_contain
+
+    def new_annotation(self, aid):
+        new_annotation = Annotation(aid)
+        self.annotations.append(new_annotation)
+        return new_annotation
+
+
+class Contain(MmifObject):
+    producer: str
+    gen_time: str
+
+    def __init__(self):
+        super().__init__()
+        self.producer = ''
+        self.gen_time = None     # datetime.datetime
+
+    def deserialize(self, mmif):
+        pass
+

usr/local/anaconda3/envs/clamssdk/lib/python3.6/site-packages/clams/vocab/__init__.py

@@ -0,0 +1,24 @@
+# TODO (krim @ 10/7/2018): reimplement with proper enum
+class AnnotationTypes(object):
+    FA = "https://vocab.clams.ai/attype/forced-alignment"
+    # FFA = "filtered-forced-alignment"
+    BD = "https://vocab.clams.ai/attype/bar-detection"
+    SD = "https://vocab.clams.ai/attype/slate-detection"
+    TD = "https://vocab.clams.ai/attype/tone-detection"
+    ND = "https://vocab.clams.ai/attype/noise-detection"
+    OCR = "https://vocab.clams.ai/attype/raw-ocr-output"
+    TBOX = "https://vocab.clams.ai/attype/text-box"
+    FACE = "https://vocab.clams.ai/attype/face-box"
+    SHOT = "https://vocab.clams.ai/attype/shot-detection"
+    # TODO linguistic annotations to leverage on the LAPPS/LIF vocab
+    # Sentences = "segment-sentences"
+    # Paragraphs = "segment-paragraphs"
+    # Tokens = "segment-tokens"
+
+
+class MediaTypes(object):
+    V = "https://vocab.clams.ai/mtype/audio-video"
+    A = "https://vocab.clams.ai/mtype/audio-only"
+    T = "https://vocab.clams.ai/mtype/text"
+    I = "https://vocab.clams.ai/mtype/image"
+

usr/local/anaconda3/envs/clamssdk/lib/python3.6/site-packages/clams_python-0.0.1a1-py3.6.egg-info/PKG-INFO

@@ -0,0 +1,32 @@
+Metadata-Version: 2.1
+Name: clams-python
+Version: 0.0.1a1
+Summary: A collection of APIs to develop CLAMS app for python
+Home-page: https://www.clams.ai
+Author: Brandeis Lab for Linguistics and Computation
+Author-email: admin@clams.ai
+License: UNKNOWN
+Description: # CLAMS sdk for python 
+        
+        ## installation: 
+        ```
+        python setup.py install
+        ```
+        This will install a packge `clams` to local python 
+        
+        ## APIs
+        
+        
+        `clams.ClamsApp` : an abstract class for clams tool s
+        
+        `clams.Mmif` : serialization APIs
+        
+Platform: UNKNOWN
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Framework :: Flask
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers 
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown

{clams-python-0.0.1/clams_python.egg-info → usr/local/anaconda3/envs/clamssdk/lib/python3.6/site-packages/clams_python-0.0.1a1-py3.6.egg-info}/SOURCES.txt

@@ -2,10 +2,13 @@ README.md
 setup.py
 clams/__init__.py
 clams/restify/__init__.py
+clams/serialize/__init__.py
 clams/serve/__init__.py
+clams/vocab/__init__.py
 clams_python.egg-info/PKG-INFO
 clams_python.egg-info/SOURCES.txt
 clams_python.egg-info/dependency_links.txt
 clams_python.egg-info/top_level.txt
-test/__init__.py
-test/test_clamsapp.py
+tests/__init__.py
+tests/test_clamsapp.py
+tests/test_serialization.py

{clams-python-0.0.1/clams_python.egg-info → usr/local/anaconda3/envs/clamssdk/lib/python3.6/site-packages/clams_python-0.0.1a1-py3.6.egg-info}/top_level.txt

@@ -1,2 +1,2 @@
 clams
-test
+tests

usr/local/anaconda3/envs/clamssdk/lib/python3.6/site-packages/tests/test_serialization.py

@@ -0,0 +1,30 @@
+import unittest
+
+import clams.serialize
+from clams import Mmif, Medium, MediaTypes
+
+
+dummy_attype = "http://clams.ai/vocab/dummy"
+
+class ExampleInputMMIF(object):
+
+    @staticmethod
+    def get_gold_mmif():
+        mmif = Mmif()
+        mmif.context = "mmif-prototype-0.0.1.jsonld"
+        mmif.metadata = {}
+        mmif.media = [Medium(0, MediaTypes.V, "/dummy/dir/dummy.file.mp4")]
+        mmif.contains = {}
+        mmif.views = []
+        return str(mmif)
+
+
+class TestSerialization(unittest.TestCase):
+
+    def setUp(self):
+        self.mmif = Mmif(ExampleInputMMIF.get_gold_mmif())
+
+    def test_view_is_empty(self):
+        self.assertEqual(len(self.mmif.contains), 0)
+        self.assertEqual(len(self.mmif.views), 0)
+

clams-python-0.0.1/PKG-INFO

@@ -1,36 +0,0 @@
-Metadata-Version: 2.1
-Name: clams-python
-Version: 0.0.1
-Summary: A collection of APIs to develop CLAMS app for python
-Home-page: https://www.clams.ai
-Author: Brandeis Lab for Linguistics and Computation
-Author-email: admin@clams.al
-License: UNKNOWN
-Description: # CLAMS sdk for python 
-        
-        **NOTE** that this project is in pre-alpha and being actively developed. Nothing is guaranteed to reliably work for the moment and developer need to be very careful when using APIs implemented here. Please use [the issue track](../../issues) to report bugs and malfunctions, or send pull requests for even more contribution. 
-        
-        ## CLAMS project
-        [CLAMS project](https://www.clams.ai) aims at free and open-source software platform for computational analysis and metadata generation applications for multimedia material. 
-        
-        ## installation: 
-        Package `clams-python` is distributed via the official pypi. Users are supposed to pip-install to get latest release. 
-        ```
-        pip install clams-python
-        ```
-        This will install a packge `clams` to local python 
-        
-        ## APIs
-        
-        
-        `clams.ClamsApp` : an abstract class for clams apps
-        
-Platform: UNKNOWN
-Classifier: Development Status :: 2 - Pre-Alpha
-Classifier: Framework :: Flask
-Classifier: Framework :: Pytest
-Classifier: Intended Audience :: Developers 
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Programming Language :: Python :: 3 :: Only
-Requires-Python: >=3.6
-Description-Content-Type: text/markdown

clams-python-0.0.1/README.md

@@ -1,18 +0,0 @@
-# CLAMS sdk for python 
-
-**NOTE** that this project is in pre-alpha and being actively developed. Nothing is guaranteed to reliably work for the moment and developer need to be very careful when using APIs implemented here. Please use [the issue track](../../issues) to report bugs and malfunctions, or send pull requests for even more contribution. 
-
-## CLAMS project
-[CLAMS project](https://www.clams.ai) aims at free and open-source software platform for computational analysis and metadata generation applications for multimedia material. 
-
-## installation: 
-Package `clams-python` is distributed via the official pypi. Users are supposed to pip-install to get latest release. 
-```
-pip install clams-python
-```
-This will install a packge `clams` to local python 
-
-## APIs
-
-
-`clams.ClamsApp` : an abstract class for clams apps

clams-python-0.0.1/clams_python.egg-info/PKG-INFO

@@ -1,36 +0,0 @@
-Metadata-Version: 2.1
-Name: clams-python
-Version: 0.0.1
-Summary: A collection of APIs to develop CLAMS app for python
-Home-page: https://www.clams.ai
-Author: Brandeis Lab for Linguistics and Computation
-Author-email: admin@clams.al
-License: UNKNOWN
-Description: # CLAMS sdk for python 
-        
-        **NOTE** that this project is in pre-alpha and being actively developed. Nothing is guaranteed to reliably work for the moment and developer need to be very careful when using APIs implemented here. Please use [the issue track](../../issues) to report bugs and malfunctions, or send pull requests for even more contribution. 
-        
-        ## CLAMS project
-        [CLAMS project](https://www.clams.ai) aims at free and open-source software platform for computational analysis and metadata generation applications for multimedia material. 
-        
-        ## installation: 
-        Package `clams-python` is distributed via the official pypi. Users are supposed to pip-install to get latest release. 
-        ```
-        pip install clams-python
-        ```
-        This will install a packge `clams` to local python 
-        
-        ## APIs
-        
-        
-        `clams.ClamsApp` : an abstract class for clams apps
-        
-Platform: UNKNOWN
-Classifier: Development Status :: 2 - Pre-Alpha
-Classifier: Framework :: Flask
-Classifier: Framework :: Pytest
-Classifier: Intended Audience :: Developers 
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Programming Language :: Python :: 3 :: Only
-Requires-Python: >=3.6
-Description-Content-Type: text/markdown

clams-python-0.0.1/setup.cfg

@@ -1,4 +0,0 @@
-[egg_info]
-tag_build = 
-tag_date = 0
-

clams-python-0.0.1/setup.py

@@ -1,25 +0,0 @@
-import setuptools
-
-with open('README.md') as readme:
-    long_desc = readme.read()
-
-setuptools.setup(
-    name="clams-python", 
-    version="0.0.1",
-    author="Brandeis Lab for Linguistics and Computation", 
-    author_email="admin@clams.al",
-    description="A collection of APIs to develop CLAMS app for python", 
-    long_description=long_desc,
-    long_description_content_type="text/markdown",
-    url="https://www.clams.ai",
-    classifiers=[
-    'Development Status :: 2 - Pre-Alpha',
-    'Framework :: Flask',
-    'Framework :: Pytest',
-    'Intended Audience :: Developers ',
-    'License :: OSI Approved :: Apache Software License',
-    'Programming Language :: Python :: 3 :: Only',
-    ],
-    python_requires='>=3.6',
-    packages=setuptools.find_packages() 
-)