initial push

Author: shaileshmishra

.gitignore

@@ -0,0 +1,113 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+/reports
+/tests/reports
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+*.DS_Store
+*.DS_Store?
+.pytest_cache
+.idea
+.vscode
+.report.log
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.idea/
+.vscode/

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2020 Contentstack
+
+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.

README.md

@@ -0,0 +1,12 @@
+================
+**CHANGELOG**
+================
+
+ENHANCEMENT, NEW FEATURE, BUG RESOLVE
+
+*v0.0.1*
+============
+
+**Date: 20-Nov-2020**
+
+ - initial release of contentstack utility package

changelog.rst

@@ -0,0 +1,20 @@
+# The __init__.py files are required to make Python treat the directories as containing
+# packages; this is done to prevent directories with a common name, such as string,
+# from unintentionally hiding valid modules that occur later on the module search path
+# Used: Safety checks your installed dependencies for known security vulnerabilities
+# file __init__.py contains package information like
+# __author__, __status__, __version__, __endpoint__ and __email__
+
+from .embedded.item_type import ItemType
+from .embedded.style_type import StyleType
+from .helper.metadata import Metadata
+from .render.default_options import DefaultOptions
+from .render.options import OptionsCallback
+from .utils import Utils
+
+__title__ = 'Contentstack'
+__author__ = 'Contentstack'
+__status__ = 'debug'
+__version__ = '0.0.1'
+__endpoint__ = 'cdn.contentstack.io'
+__email__ = 'shailesh.mishra@contentstack.com'

contentstack/__init__.py

@@ -0,0 +1,8 @@
+import enum
+
+
+class ItemType(enum.Enum):
+    """
+    """
+    ENTRY = 'entry'
+    ASSET = 'asset'

contentstack/embedded/item_type.py

@@ -0,0 +1,14 @@
+""""
+For `Entry`: StyleType.BLOCK, StyleType.INLINE, StyleType.LINKED,
+For `Assets`: StyleType.DISPLAY, StyleType.DOWNLOADABLE
+ """
+import enum
+
+
+class StyleType(enum.Enum):
+
+    BLOCK = "block"
+    INLINE = 'inline'
+    LINK = 'link'
+    DISPLAY = 'displayable'
+    DOWNLOADABLE = 'downloadable'

contentstack/embedded/style_type.py

@@ -0,0 +1,49 @@
+from contentstack.embedded.style_type import StyleType
+
+
+class Metadata:
+
+    def __init__(self, text: str, item_type: str, item_uid: str, content_type_uid: str, style_type: StyleType,
+                 outer_html: str, attributes: str):
+        self.text = text
+        self.item_type = item_type
+        self.item_uid = item_uid
+        self.content_type_uid = content_type_uid
+        self.style_type = style_type
+        self.outer_html = outer_html
+        self.attributes = attributes
+
+    # getter get_text() method
+    @property
+    def get_text(self):
+        return self.text
+
+    # getter get_item_type() method
+    @property
+    def get_item_type(self):
+        return self.item_type
+
+    # getter get_item_uid() method
+    @property
+    def get_item_uid(self):
+        return self.item_uid
+
+    # getter get_content_type_uid() method
+    @property
+    def get_content_type_uid(self):
+        return self.content_type_uid
+
+    # getter get_style_type() method
+    @property
+    def get_style_type(self):
+        return self.style_type
+
+    # getter get_outer_html() method
+    @property
+    def get_outer_html(self):
+        return self.outer_html
+
+    # getter get_attributes() method
+    @property
+    def get_attributes(self):
+        return self.attributes

contentstack/helper/metadata.py

@@ -0,0 +1,45 @@
+# pylint: disable=missing-function-docstring
+# pylint: disable=missing-docstring
+# pylint: disable=too-few-public-methods
+
+from contentstack.helper.metadata import Metadata
+
+
+def _title_or_uid(embedded_obj: dict) -> str:
+    _title = ""
+    if embedded_obj is not None:
+        if 'title' in embedded_obj and len(embedded_obj['title']) != 0:
+            _title = embedded_obj['title']
+        elif 'uid' in embedded_obj:
+            _title = embedded_obj['uid']
+    return _title
+
+
+def _asset_title_or_uid(embedded_obj: dict) -> str:
+    _title = ""
+    if embedded_obj is not None:
+        if 'title' in embedded_obj and len(embedded_obj['title']) != 0:
+            _title = embedded_obj['title']
+        elif 'filename' in embedded_obj:
+            _title = embedded_obj['filename']
+        elif 'uid' in embedded_obj:
+            _title = embedded_obj['uid']
+    return _title
+
+
+class DefaultOptions:
+
+    @staticmethod
+    def render_options(embedded_obj: dict, metadata: Metadata) -> str:
+        if metadata.style_type.name == 'block':
+            return '<div><p>' + _title_or_uid(embedded_obj) \
+                   + '</p><div><p>Content type: <span>' + embedded_obj['_content_type_uid'] \
+                   + '</span></p></div>'
+        elif metadata.style_type.name == 'inline':
+            return '<span>' + _title_or_uid(embedded_obj) + '</span>'
+        elif metadata.style_type.name == 'link':
+            return '<a href=' + embedded_obj['url'] + '>' + _title_or_uid(embedded_obj) + '</a>'
+        elif metadata.style_type.name == 'display':
+            return '<img src=' + embedded_obj['url'] + ' alt=' \
+                   + _asset_title_or_uid(embedded_obj) + '/>'
+        return ''

contentstack/render/default_options.py

@@ -0,0 +1,9 @@
+# pylint: disable=missing-function-docstring
+from contentstack.helper.metadata import Metadata
+
+
+class OptionsCallback:
+
+    @staticmethod
+    def render_options(self, embedded_obj: dict, metadata: Metadata) -> str:
+        return 'string'