Metadata-Version: 2.1
Name: ni-core-server
Version: 0.1.3
Summary: UNKNOWN
Home-page: https://github.com/pypa/sampleproject
Author: Primael Bruant
Author-email: primael.bruant@gmail.com
License: UNKNOWN
Description: # Core Server
        
        ## Quick Start
        
        ### With Pypi
        
        Install product with:
        
        ```shell script
        pip install ni-core-server==0.1.1
        ```
        
        To launch server:
        
        ```shell script
        core_server
        ```
        
        Some options are available:
        
        * `-p` | `--port` server port listening. Default: 8888
        * `-l` | `--log-level` log level. Default 'INFO'
        
        ### With Docker
        
        Install product with:
        
        ```shell script
        docker pull primael94/ni-core-server:0.1.1
        ```
        
        To launch server:
        
        ```shell script
        docker run -d -p 8888:8888 primael94/ni-core-server:0.1.1
        ```
        
        Some environment variables are available:
        
        * `RABBIT_HOST` Host IP of rabbit. Default: rabbit
        * `LEVEL_DEBUG` Log level. Default 'INFO'
        * `PORT_SERVER` Server port listening. Default: 8888
        
        ### With docker-compose
        
        ```yaml
        ---
        
        version: "3"
        
        services:
          rabbitmq:
            image: rabbitmq:3-management
          core-server:
            build:
              .
            environment:
              - RABBIT_HOST=rabbitmq
              - LEVEL_DEBUG=DEBUG
            depends_on:
              - rabbitmq
            ports:
            - 8888:8888
        ```
        
        ## Under the hood
        
        ### Pipeline concept
        
        When we submitting an image, that create a dedicated pipeline.
        
        A pipeline is a job stack.
        
        ![](doc/images/pipeline.vpd.jpg)
        
        ### API
        
        #### [POST] /upload
        
        Endpoint to submit one or more images in system.
        
        ##### Datas
        
        | name   | type | numbers | required |
        |--------|:----:|:-------:|:--------:|
        | _free_ | file | n       | __yes__  |
        | data   | json | 1       | __yes__  |
        
        `data` should contain at least `operations`.
        
        `operations` represents a list of operations comma separated.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
