Metadata-Version: 2.1
Name: mockintosh
Version: 0.0
Summary: The API mocking server for microservice environments
Home-page: https://github.com/up9inc/mockintosh
Author: UP9 Inc.
License: MIT
Description: # Mockintosh, the API mocking server for microservice environments
        
        ## About
        
        Mockintosh aims to provide usual mock service functionality with small resource footprint, making it friendly for
        microservice applications. You can have tens of mocks at once, inside moderate laptop or single Docker container. Also,
        we have some additional ideas on how to make mocks simple and useful.
        
        Key features:
        
        - multiple services mocked by a single instance of Mockintosh
        - lenient [configuration syntax](Configuring.md)
        - performance testing supported
        
        ## Quick Start
        
        If you have installed Mockintosh as Python package, start it with JSON/YAML [configuration file](Configuring.md) as
        parameter:
        
        ```bash
        mockintosh my_mocks.yaml
        ```
        
        After server starts, you can issue requests against it.
        
        Alternatively, you can run Mockintosh as Docker container:
        
        ```bash
        docker run -it -p 8000-8005:8000-8005 -v `pwd`:/tmp mockintosh:latest /tmp/config.json
        ```
        Please note the `-p` flag used to publish container ports and `-v` to mount directory with config into container.
        
        ---
        
        ## Build
        
        Installing it directly:
        
        ```bash
        pip3 install .
        ```
        
        or as a Docker image:
        
        ```bash
        docker build --no-cache -t mockintosh .
        ```
        
        To verify the installation run `mockintosh` and visit [http://localhost:8001](http://localhost:8001)
        you should be seeing the `hello world` response.
        
        ## Run
        
        Running directly:
        
        ```bash
        mockintosh tests/configs/json/hbs/common/config.json
        ```
        
        or as a Docker container:
        
        ```bash
        docker run -p 8000-8010:8000-8010 -v `pwd`/tests/configs/json/hbs/common/config.json mockintosh /config.json
        # or
        docker run --network host -v `pwd`/tests/configs/json/hbs/common/config.json mockintosh /config.json
        ```
        
        ### Command-line Arguments
        
        The list of command-line arguments can be seen by running `mockintosh --help`.
        
        If no configuration file is provided `mockintosh` starts with the default config shown below:
        
        ```json
        {
          "services": [
            {
              "comment": "Default Mock Service Config",
              "hostname": "localhost",
              "port": 8001,
              "endpoints": [
                {
                  "path": "/",
                  "method": "GET",
                  "response": "hello world"
                }
              ]
            }
          ]
        }
        ```
        
        Mockintosh also supports piping config text into its `stdin` like:
        
        ```bash
        cat tests/configs/json/hbs/common/config.json | mockintosh
        ```
        
        `--debug` option enables Tornado Web Server's debug mode.
        
        Using `--quiet` and `--verbose` options the logging level can be changed.
        
        
Keywords: mock api json restful automatic web server generator configuration
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3 :: Only
Description-Content-Type: text/markdown
Provides-Extra: dev
