Metadata-Version: 1.1
Name: flask-snow
Version: 0.2.5
Summary: Pysnow extension for Flask
Home-page: https://github.com/rbw0/flask-snow
Author: Robert Wikman
Author-email: rbw@vault13.org
License: MIT
Download-URL: https://github.com/rbw0/flask-snow/tarball/0.2.5
Description: .. image:: https://coveralls.io/repos/github/rbw0/flask-snow/badge.svg?branch=master
            :target: https://coveralls.io/github/rbw0/flask-snow?branch=master
        .. image:: https://travis-ci.org/rbw0/flask-snow.svg?branch=master
            :target: https://travis-ci.org/rbw0/flask-snow
        .. image:: https://badge.fury.io/py/flask-snow.svg
            :target: https://pypi.python.org/pypi/flask-snow
        .. image:: https://img.shields.io/badge/License-MIT-green.svg
            :target: https://opensource.org/licenses/MIT
            
        flask-snow
        ===========
        
        Build apps on top of the ServiceNow REST API using the lightweight `Flask microframework <http://flask.pocoo.org>`_
        
        - Uses the `pysnow library <https://github.com/rbw0/pysnow>`_.
        - Supports OAuth for a seamless authentication / authorization experience.
        
        Installation
        ------------
        
        $ pip install flask-snow
        
        
        Documentation
        -------------
        The documentation can be found `here <http://flask-snow.readthedocs.org/>`_
        
        
        Usage
        -----
        
        Minimal server. Does the following:
        
        #. Sets config
        #. Creates ``Snow`` instance
        #. Queries the *incident table* by number
        #. Returns *JSON representation* of the result
        
        .. code-block:: python
        
            from flask import Flask, jsonify
            from flask_snow import Snow
        
            app = Flask(__name__)
            app.config['SNOW_INSTANCE'] = '<instance name>'
            app.config['SNOW_USER'] = '<user name>'
            app.config['SNOW_PASSWORD'] = '<password>'
        
            snow = Snow(app)
        
            @app.route('/incidents/<number>')
            def incident(number):
                incident = snow.resource(api_path='/table/incident')
                response = incident.get(query={'number': number}).one_or_none() or {}
                return jsonify(response)
        
            if __name__ == '__main__':
                app.run()
        
        
        
        Name it **server.py** and run with ``python server.py``
        
        
        Check out the `examples <https://github.com/rbw0/flask-snow/tree/master/examples>`_  for more!
        
        
        Compatibility
        -------------
        - Python 2 and 3
        - Flask > 0.9
        
        Author
        ------
        Created by Robert Wikman <rbw@vault13.org> in 2018
        
        JetBrains
        ---------
        Thank you `Jetbrains <http://www.jetbrains.com>`_ for creating pycharm and for providing me with free licenses
        
        
        
Platform: any
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
