Metadata-Version: 1.1
Name: flask2postman
Version: 1.4.4
Summary: Generate a Postman collection from your Flask application
Home-page: https://github.com/numberly/flask2postman
Author: Guillaume Gelin
Author-email: ramnes@1000mercis.com
License: MIT
Description: .. _Postman: https://www.getpostman.com/
        .. _Flask: http://flask.pocoo.org/
        
        =============
        flask2postman
        =============
        
        .. image:: https://img.shields.io/pypi/v/flask2postman.svg
           :target: https://pypi.python.org/pypi/flask2postman
        .. image:: https://img.shields.io/github/license/numberly/flask2postman.svg
           :target: https://github.com/numberly/flask2postman/blob/master/LICENSE
        
        |
        
        A tool that creates a Postman_ collection from a Flask_ application.
        
        
        Install
        =======
        
        .. code-block:: sh
        
            $ pip install flask2postman
        
        
        Example
        =======
        
        Let's say that you have a Flask project called "example" (see
        :code:`example.py`), and you want to generate a Postman collection out of it.
        
        You just need to tell :code:`flask2postman` how to import the Flask instance,
        and optionally give a name to the Postman collection:
        
        .. code-block:: sh
        
            $ flask2postman example.app --name "Example Collection" --folders > example.json
        
        If you don't have a global Flask instance but rather use a function to
        initialize your application, that works too:
        
        .. code-block:: sh
        
            $ flask2postman example.create_app --name "Example Collection" --folders > example.json
        
        This will generate the JSON configuration, and write it into the
        :code:`example.json` file. You can then import this file into Postman ("Import
        Collection" button), and profit:
        
        .. image:: https://raw.githubusercontent.com/1000mercis/flask2postman/42d20fe89d9d1f831bbfbe6275471e624d40c488/img/screenshot.jpg
            :alt: Postman screenshot
        
        On a side note, you can see that endpoint's docstrings are automatically
        imported as descriptions.
        
        
        Usage
        =====
        
        .. code-block:: sh
        
            usage: flask2postman [-h] [-n NAME] [-b BASE_URL] [-a] [-i] [-f]
                                 flask_instance
        
            positional arguments:
              flask_instance
        
            optional arguments:
              -h, --help            show this help message and exit
              -n NAME, --name NAME  Postman collection name (default: current directory
                                    name)
              -b BASE_URL, --base_url BASE_URL
                                    the base of every URL (default: {{base_url}})
              -a, --all             also generate OPTIONS/HEAD methods
              -s, --static          also generate /static/{{filename}} (Flask internal)
              -i, --indent          indent the output
              -f, --folders         add Postman folders for blueprints
        
        
        License
        =======
        
        MIT
        
Platform: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Framework :: Flask
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
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: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: Utilities
