colony-print 0.2.0__tar.gz

colony-print-0.2.0/PKG-INFO

@@ -0,0 +1,89 @@
+Metadata-Version: 2.1
+Name: colony-print
+Version: 0.2.0
+Summary: Colony Print Infra-structure
+Home-page: http://colony-print.hive.pt
+Author: Hive Solutions Lda.
+Author-email: development@hive.pt
+License: Apache License, Version 2.0
+Description: # [Colony Print Infra-structure](http://colony-print.hive.pt)
+        
+        Small web app for printing of Colony based documents.
+        
+        This project includes two main components:
+        
+        * The web app end point that allows for XML to Binie conversion `colony_print.controllers`
+        * The structure conversion infra-structure (visitors, ast, etc.) `colony_print.printing`
+        
+        ## Installation
+        
+        ### Pre-requisites
+        
+        ```bash
+        apt-get install gcc python-dev
+        pip install --upgrade appier netius pillow reportlab
+        ```
+        
+        ### Run Server
+        
+        ```bash
+        pip install colony_print
+        python -m colony_print.main
+        ```
+        
+        ### Run Node
+        
+        ```bash
+        pip install colony_print
+        BASE_URL=$BASE_URL \
+        SECRET_KEY=$SECRET_KEY \
+        NODE_ID=$NODE_ID \
+        NODE_NAME=$NODE_NAME \
+        NODE_LOCATION=$NODE_LOCATION \
+        python -m colony_print.node
+        ```
+        
+        ### Fonts
+        
+        To be able to use new fonts (other than the ones provided by the system) one must install them
+        into the `/usr/share/fonts/truetype` directory so they are exposed and ready to
+        be used by the PDF generation infra-structure. For example calibri is one type of font that should
+        be exported to an UNIX machine as it is used by mani colony generated documents.
+        
+        ## Running
+        
+        ```bash
+        PORT=8686 \
+        PYTHONPATH=$BASE_PATH/colony_print/src python \
+        $BASE_PATH/colony_print/src/colony_print/main.py
+        ```
+        
+        ## License
+        
+        Colony Print Infra-structure is currently licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/).
+        
+        ## Build Automation
+        
+        [![Build Status](https://app.travis-ci.com/hivesolutions/colony-print.svg?branch=master)](https://travis-ci.com/github/hivesolutions/colony-print)
+        [![Coverage Status](https://coveralls.io/repos/hivesolutions/colony-print/badge.svg?branch=master)](https://coveralls.io/r/hivesolutions/colony-print?branch=master)
+        [![PyPi Status](https://img.shields.io/pypi/v/colony-print.svg)](https://pypi.python.org/pypi/colony-print)
+        [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://www.apache.org/licenses/)
+        
+Keywords: colony print native
+Platform: UNKNOWN
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Topic :: Utilities
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 2.6
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3.0
+Classifier: Programming Language :: Python :: 3.1
+Classifier: Programming Language :: Python :: 3.2
+Classifier: Programming Language :: Python :: 3.3
+Classifier: Programming Language :: Python :: 3.4
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Description-Content-Type: text/markdown

colony-print-0.2.0/README.md

@@ -0,0 +1,62 @@
+# [Colony Print Infra-structure](http://colony-print.hive.pt)
+
+Small web app for printing of Colony based documents.
+
+This project includes two main components:
+
+* The web app end point that allows for XML to Binie conversion `colony_print.controllers`
+* The structure conversion infra-structure (visitors, ast, etc.) `colony_print.printing`
+
+## Installation
+
+### Pre-requisites
+
+```bash
+apt-get install gcc python-dev
+pip install --upgrade appier netius pillow reportlab
+```
+
+### Run Server
+
+```bash
+pip install colony_print
+python -m colony_print.main
+```
+
+### Run Node
+
+```bash
+pip install colony_print
+BASE_URL=$BASE_URL \
+SECRET_KEY=$SECRET_KEY \
+NODE_ID=$NODE_ID \
+NODE_NAME=$NODE_NAME \
+NODE_LOCATION=$NODE_LOCATION \
+python -m colony_print.node
+```
+
+### Fonts
+
+To be able to use new fonts (other than the ones provided by the system) one must install them
+into the `/usr/share/fonts/truetype` directory so they are exposed and ready to
+be used by the PDF generation infra-structure. For example calibri is one type of font that should
+be exported to an UNIX machine as it is used by mani colony generated documents.
+
+## Running
+
+```bash
+PORT=8686 \
+PYTHONPATH=$BASE_PATH/colony_print/src python \
+$BASE_PATH/colony_print/src/colony_print/main.py
+```
+
+## License
+
+Colony Print Infra-structure is currently licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/).
+
+## Build Automation
+
+[![Build Status](https://app.travis-ci.com/hivesolutions/colony-print.svg?branch=master)](https://travis-ci.com/github/hivesolutions/colony-print)
+[![Coverage Status](https://coveralls.io/repos/hivesolutions/colony-print/badge.svg?branch=master)](https://coveralls.io/r/hivesolutions/colony-print?branch=master)
+[![PyPi Status](https://img.shields.io/pypi/v/colony-print.svg)](https://pypi.python.org/pypi/colony-print)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://www.apache.org/licenses/)

colony-print-0.2.0/setup.cfg

@@ -0,0 +1,7 @@
+[bdist_wheel]
+universal = 1
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

colony-print-0.2.0/setup.py

@@ -0,0 +1,63 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+import os
+import setuptools
+
+setuptools.setup(
+    name = "colony-print",
+    version = "0.2.0",
+    author = "Hive Solutions Lda.",
+    author_email = "development@hive.pt",
+    description = "Colony Print Infra-structure",
+    license = "Apache License, Version 2.0",
+    keywords = "colony print native",
+    url = "http://colony-print.hive.pt",
+    zip_safe = False,
+    packages = [
+        "colony_print",
+        "colony_print.controllers",
+        "colony_print.printing",
+        "colony_print.printing.binie",
+        "colony_print.printing.common",
+        "colony_print.printing.manager",
+        "colony_print.printing.pdf"
+    ],
+    test_suite = "colony_print.test",
+    package_dir = {
+        "" : os.path.normpath("src")
+    },
+    package_data = {
+        "colony_print" : [
+            "static/example/*",
+            "static/example/js/*",
+            "static/example/xml/*"
+        ]
+    },
+    install_requires = [
+        "appier",
+        "appier-extras",
+        "jinja2",
+        "pillow",
+        "reportlab"
+    ],
+    classifiers = [
+        "Development Status :: 5 - Production/Stable",
+        "Topic :: Utilities",
+        "License :: OSI Approved :: Apache Software License",
+        "Operating System :: OS Independent",
+        "Programming Language :: Python",
+        "Programming Language :: Python :: 2.6",
+        "Programming Language :: Python :: 2.7",
+        "Programming Language :: Python :: 3.0",
+        "Programming Language :: Python :: 3.1",
+        "Programming Language :: Python :: 3.2",
+        "Programming Language :: Python :: 3.3",
+        "Programming Language :: Python :: 3.4",
+        "Programming Language :: Python :: 3.5",
+        "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: 3.7"
+    ],
+    long_description = open(os.path.join(os.path.dirname(__file__), "README.md"), "rb").read().decode("utf-8"),
+    long_description_content_type = "text/markdown"
+)

colony-print-0.2.0/src/colony_print/__init__.py

@@ -0,0 +1,10 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+from . import controllers
+from . import printing
+from . import main
+
+from .controllers import *
+from .printing import *
+from .main import ColonyPrintApp

colony-print-0.2.0/src/colony_print/controllers/__init__.py

@@ -0,0 +1,12 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+from . import base
+from . import document
+from . import node
+from . import printer
+
+from .base import BaseController
+from .document import DocumentController
+from .node import NodeController
+from .printer import PrinterController

colony-print-0.2.0/src/colony_print/controllers/base.py

@@ -0,0 +1,7 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+import appier
+
+class BaseController(appier.Controller):
+    pass

colony-print-0.2.0/src/colony_print/controllers/document.py

@@ -0,0 +1,79 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+import base64
+
+import appier
+
+MIME = dict(
+    binie = "text/x-binie",
+    pdf = "application/pdf"
+)
+""" Map defining the association between the print
+format naming and the associated base mime type value
+(note that this value may be complemented with base64) """
+
+EXAMPLE = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\
+    <printing_document name=\"hello_world\" font=\"Calibri\" font_size=\"9\">\
+        <paragraph text_align=\"center\">\
+            <line><text>Hello World</text></line>\
+        </paragraph>\
+    </printing_document>"
+""" Example XML string that should display an hello world
+message using the XML printing language """
+
+class DocumentController(appier.Controller):
+
+    def __init__(self, owner, *args, **kwargs):
+        appier.Controller.__init__(self, owner, *args, **kwargs)
+        self.manager = None
+
+    @appier.route("/documents/example.<format>", "GET")
+    def example(self, format):
+        return self.send_print(EXAMPLE, format)
+
+    @appier.route("/documents.<format>", "POST")
+    def convert(self, format):
+        # retrieves the current request reference and then
+        # uses it to retrieve its "raw" data, that should
+        # contain the XML string for the generation of the
+        # of binie result and then sends the value for print
+        request = self.get_request()
+        data = request.get_data()
+        return self.send_print(data, format = format)
+
+    def send_print(self, data, format = "binie"):
+        # retrieves the various optional fields for printing
+        # and then parses them creating the composite values
+        # (should include the size tuple)
+        b64 = self.field("base64", False, cast = bool)
+        width = self.field("width", 0.0, cast = float)
+        height = self.field("height", 0.0, cast = float)
+        has_size = width > 0.0 and width > 0.0
+
+        mime = self.get_mime(format, b64 = base64)
+        manager = self.get_manager()
+
+        data = data
+        file = appier.legacy.BytesIO()
+        options = dict(name = format, file = file)
+        if has_size: options["size"] = (width, height)
+
+        manager.print_language(data, options)
+        value = file.getvalue()
+        value = base64.b64encode(value) if b64 else value
+
+        self.content_type(mime)
+        return value
+
+    def get_mime(self, format, b64 = False):
+        mime = MIME.get(format, "application/octet-stream")
+        mime = mime + "-base64" if b64 else mime
+        return mime
+
+    def get_manager(self):
+        import colony_print
+        if self.manager: return self.manager
+        self.manager = colony_print.PrintingManager()
+        self.manager.load()
+        return self.manager

colony-print-0.2.0/src/colony_print/controllers/node.py

@@ -0,0 +1,126 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+import json
+import uuid
+
+import appier
+
+HELLO_WORLD_B64 = "SGVsbG8gV29ybGQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\
+AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\
+AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\
+AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\
+AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAEAAABAAQAAAA\
+AAAAAAAABDYWxpYnJpAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\
+AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\
+AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\
+AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\
+AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACQAAAAMAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\
+AAAAAAAAAwAAABIZWxsbyBXb3JsZAA="
+
+class NodeController(appier.Controller):
+
+    @appier.route("/nodes", "GET", json = True)
+    @appier.ensure(token = "admin")
+    def list(self):
+        return self.owner.nodes
+
+    @appier.route("/nodes/<str:id>", "POST", json = True)
+    @appier.ensure(token = "admin")
+    def create(self, id):
+        node = appier.get_object()
+        self.owner.nodes[id] = node
+
+    @appier.route("/nodes/<str:id>", "GET", json = True)
+    @appier.ensure(token = "admin")
+    def show(self, id):
+        return self.owner.nodes[id]
+
+    @appier.route("/nodes/<str:id>/jobs", "GET", json = True)
+    @appier.ensure(token = "admin")
+    def jobs(self, id):
+        self.request.set_content_type("application/json")
+        for value in appier.header_a(): yield value
+        for value in self.wait_jobs(id): yield value
+
+    @appier.route("/nodes/<str:id>/jobs_peek", "GET", json = True)
+    @appier.ensure(token = "admin")
+    def jobs_peek(self, id):
+        jobs = self.owner.jobs.get(id, [])
+        return jobs
+
+    @appier.route("/nodes/<str:id>/print", ("GET", "POST"), json = True)
+    @appier.ensure(token = "admin")
+    def print_default(self, id):
+        data_b64 = self.field("data_b64", mandatory = True, not_empty = True)
+        name = self.field("name", None)
+        name = name or str(uuid.uuid4())
+        job = dict(data_b64 = data_b64)
+        if name: job["name"] = name
+        jobs = self.owner.jobs.get(id, [])
+        jobs.append(job)
+        self.owner.jobs[id] = jobs
+        appier.notify("jobs:%s" % id)
+
+    @appier.route("/nodes/<str:id>/print", "OPTIONS")
+    def print_default_o(self, id):
+        return ""
+
+    @appier.route("/nodes/<str:id>/print_hello", ("GET", "POST"), json = True)
+    @appier.ensure(token = "admin")
+    def print_hello_default(self, id):
+        self.set_field("data_b64", HELLO_WORLD_B64)
+        self.set_field("name", "hello_world")
+        self.print_default(id)
+
+    @appier.route("/nodes/<str:id>/printers/print", ("GET", "POST"), json = True)
+    @appier.ensure(token = "admin")
+    def print_printer_f(self, id):
+        printer = self.field("printer")
+        return self.print_printer(id, printer)
+
+    @appier.route("/nodes/<str:id>/printers/print", "OPTIONS")
+    def print_printer_of(self, id):
+        printer = self.field("printer")
+        return self.print_printer_o(id, printer)
+
+    @appier.route("/nodes/<str:id>/printers/print_hello", ("GET", "POST"), json = True)
+    @appier.ensure(token = "admin")
+    def print_hello_printer_f(self, id):
+        printer = self.field("printer")
+        return self.print_hello_printer(id, printer)
+
+    @appier.route("/nodes/<str:id>/printers/<str:printer>/print", ("GET", "POST"), json = True)
+    @appier.ensure(token = "admin")
+    def print_printer(self, id, printer):
+        data_b64 = self.field("data_b64", mandatory = True, not_empty = True)
+        name = self.field("name", None)
+        name = name or str(uuid.uuid4())
+        job = dict(
+            data_b64 = data_b64,
+            printer = printer
+        )
+        if name: job["name"] = name
+        jobs = self.owner.jobs.get(id, [])
+        jobs.append(job)
+        self.owner.jobs[id] = jobs
+        appier.notify("jobs:%s" % id)
+
+    @appier.route("/nodes/<str:id>/printers/<str:printer>/print", "OPTIONS")
+    def print_printer_o(self, id, printer):
+        return ""
+
+    @appier.route("/nodes/<str:id>/printers/<str:printer>/print_hello", ("GET", "POST"), json = True)
+    @appier.ensure(token = "admin")
+    def print_hello_printer(self, id, printer):
+        self.set_field("data_b64", HELLO_WORLD_B64)
+        self.set_field("name", "hello_world")
+        self.print_printer(id, printer)
+
+    @appier.coroutine
+    def wait_jobs(self, id):
+        while True:
+            jobs = self.owner.jobs.pop(id, [])
+            if jobs: break
+            for value in appier.wait("jobs:%s" % id): yield value
+        yield json.dumps(jobs)

colony-print-0.2.0/src/colony_print/controllers/printer.py

@@ -0,0 +1,33 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+import appier
+
+class PrinterController(appier.Controller):
+
+    @appier.route("/printers", "GET", json = True)
+    @appier.ensure(token = "admin")
+    def list(self):
+        return self.npcolony.get_devices()
+
+    @appier.route("/printers/hello", "GET", json = True)
+    @appier.ensure(token = "admin")
+    def hello(self):
+        self.npcolony.print_hello()
+
+    @appier.route("/printers/print", "GET", json = True)
+    @appier.ensure(token = "admin")
+    def print_document_f(self):
+        printer = self.field("printer")
+        return self.print_document(printer)
+
+    @appier.route("/printers/<str:printer>/print", ("GET", "POST"), json = True)
+    @appier.ensure(token = "admin")
+    def print_document(self, printer):
+        data_b64 = self.field("data_b64")
+        self.npcolony.print_printer_base64(printer, data_b64)
+
+    @property
+    def npcolony(self):
+        import npcolony
+        return npcolony

colony-print-0.2.0/src/colony_print/main.py

@@ -0,0 +1,25 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+import appier
+import appier_extras
+
+class ColonyPrintApp(appier.APIApp):
+
+    def __init__(self, *args, **kwargs):
+        appier.APIApp.__init__(
+            self,
+            name = "colony-print",
+            parts = (
+                appier_extras.AdminPart,
+            ),
+            *args, **kwargs
+        )
+        self.nodes = dict()
+        self.jobs = dict()
+
+if __name__ == "__main__":
+    app = ColonyPrintApp()
+    app.serve()
+else:
+    __path__ = []

colony-print-0.2.0/src/colony_print/node.py

@@ -0,0 +1,75 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+import time
+import logging
+
+import appier
+
+BASE_URL = "https://print.bemisc.com/"
+
+SLEEP_TIME = 3.0
+
+class ColonyPrintNode(object):
+
+    def __init__(self, sleep_time = SLEEP_TIME):
+        self.sleep_time = sleep_time
+
+    def loop(self):
+        logging.basicConfig(
+            format = "%(asctime)s [%(levelname)s] %(message)s",
+            level = logging.DEBUG
+        )
+
+        base_url = appier.conf("BASE_URL", BASE_URL)
+        secret_key = appier.conf("SECRET_KEY", None)
+        node_id = appier.conf("NODE_ID", "node")
+        node_name = appier.conf("NODE_NAME", "node")
+        node_location = appier.conf("NODE_LOCATION", "undefined")
+
+        headers = dict()
+        if secret_key: headers["X-Secret-Key"] = secret_key
+
+        while True:
+            try:
+                logging.info("Submitting node information")
+                appier.post(
+                    base_url + "nodes/%s" % node_id,
+                    data_j = dict(
+                        name = node_name,
+                        location = node_location
+                    ),
+                    headers = headers
+                )
+                logging.info("Retrieving jobs for node '%s'" % node_id)
+                jobs = appier.get(
+                    base_url + "nodes/%s/jobs" % node_id,
+                    headers = headers,
+                    timeout = 600
+                )
+                logging.info("Retrieved %d jobs for node '%s'" % (len(jobs), node_id))
+                for job in jobs: self.print_job(job)
+            except Exception as exception:
+                logging.info("Exception while looping '%s'" % str(exception))
+                logging.info("Sleeping for %.2f seconds" % self.sleep_time)
+                time.sleep(self.sleep_time)
+
+    def print_job(self, job):
+        data_b64 = job["data_b64"]
+        name = job.get("name", "undefined")
+        printer = job.get("printer", None)
+        printer_s = printer if printer else "default"
+        logging.info("Printing job '%s' with '%s' printer" % (name, printer_s))
+        if printer: self.npcolony.print_printer_base64(printer, data_b64)
+        else: self.npcolony.print_base64(data_b64)
+
+    @property
+    def npcolony(self):
+        import npcolony
+        return npcolony
+
+if __name__ == "__main__":
+    node = ColonyPrintNode()
+    node.loop()
+else:
+    __path__ = []

colony-print-0.2.0/src/colony_print/printing/__init__.py

@@ -0,0 +1,12 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+from . import binie
+from . import common
+from . import manager
+from . import pdf
+
+from .binie import *
+from .common import *
+from .manager import *
+from .pdf import *

colony-print-0.2.0/src/colony_print/printing/binie/__init__.py

@@ -0,0 +1,10 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+from . import exceptions
+from . import system
+from . import visitor
+
+from .exceptions import PrintingBinieException, InvalidContextInformationName
+from .system import PrintingBinie
+from .visitor import Visitor

colony-print-0.2.0/src/colony_print/printing/binie/exceptions.py

@@ -0,0 +1,36 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+class PrintingBinieException(Exception):
+    """
+    The printing binie exception class.
+    """
+
+    message = None
+    """ The exception's message """
+
+class InvalidContextInformationName(PrintingBinieException):
+    """
+    The invalid context information name class.
+    """
+
+    def __init__(self, message):
+        """
+        Constructor of the class.
+
+        :type message: String
+        :param message: The message to be printed.
+        """
+
+        PrintingBinieException.__init__(self)
+        self.message = message
+
+    def __str__(self):
+        """
+        Returns the string representation of the class.
+
+        :rtype: String
+        :return: The string representation of the class.
+        """
+
+        return "Invalid context information name - %s" % self.message