Skip to main content

A wrapper for using nameko services with Flask

Project description

# flask_nameko

A wrapper for using nameko services with Flask

## Installation

Install it via PyPI:

pip install flask_nameko

## Usage

To start using `flask_nameko`, you need to create and configure a new `FlaskPooledClusterRpcProxy` singleton, which you'll use to communicate with your Nameko cluster.

from flask import Flask
from flask_nameko import FlaskPooledClusterRpcProxy

rpc = FlaskPooledClusterRpcProxy()

def create_app():
app = Flask(__name__)


app = create_app()

Then, you can use the `FlaskPooledClusterRpcProxy` singleton just as you would normally use a `ClusterRpcProxy`, by accessing individual services by name and calling methods on them:


from . import (

def index():
result = rpc.service.do_something('test')
return result

## API

### Configuration

`FlaskPooledClusterRpcProxy` accepts all nameko configuration values, prefixed with the `NAMEKO_` prefix. In addition, it exposes additional configuration options:

* `NAMEKO_INITIAL_CONNECTIONS (int, default=2)` - the number of initial connections to the Nameko cluster to create
* `NAMEKO_MAX_CONNECTIONS (int, default=8)` - the max number of connections to the Nameko cluster to create before raises an error
* `NAMEKO_CONNECT_ON_METHOD_CALL (bool, default=True)` - whether connections to services should be loaded when the service is accessed (False) or when a method is called on a service (True)
* `NAMEKO_RPC_TIMEOUT` (int, default=None) - the default timeout before raising an error when trying to call a service RPC method
* `NAMEKO_POOL_RECYCLE` (int, default=None) - if specified, connections that are older than this interval, specified in seconds, will be automatically recycled on checkout. This setting is useful for environments where connections are happening through a proxy like HAProxy which automatically closes connections after a specified interval.

### Proxies

*flask_nameko.**FlaskPooledClusterRpcProxy**(app=None, connect_on_method_call=True)*

This class is used to create a pool of connections to a Nameko cluster. It provides the following options:

* `connect_on_method_call` - if this is true, the connection to a service is created when a method is called on a service rather than when the service is accessed


Configure the proxy for a given app.

## Development

$ git clone flask_nameko
$ cd flask_nameko
$ make develop


`1.4.0 <>`__ (2017-09-10)


- **Python**: Python 3 support + fix pep8 voilations
(`69d116 <>`__)

`1.3.0 <>`__ (2016-09-20)


- **README**: adds docs for NAMEKO\_POOL\_RECYCLE
(`a27a1be <>`__)


- **ConnectionPool**: add pool recycling to eliminate closed connection
(`4d90f1d <>`__)

`1.2.0 <>`__ (2016-09-16)


- **PooledClusterRpcProxy**: add support for NAMEKO\_RPC\_TIMEOUT
(`d4d6042 <>`__)

`1.1.0 <>`__ (2016-08-09)


- **FlaskPooledClusterRpcProxy**: add lazy\_load\_services config
(`26184f6 <>`__)

`0.1.0 <>`__ (2016-07-28)


- **flask\_nameko**: adds FlaskPooledClusterRpcProxy
(`285df05 <>`__)


* First release on PyPI.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for flask_nameko, version 1.4.0
Filename, size File type Python version Upload date Hashes
Filename, size flask_nameko-1.4.0.tar.gz (7.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page