• Stars
    star
    797
  • Rank 54,929 (Top 2 %)
  • Language
    Python
  • License
    Apache License 2.0
  • Created over 8 years ago
  • Updated about 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Python3 client for NATS

NATS - Python3 Client for Asyncio

An asyncio Python client for the NATS messaging system.

docs pypi Build Status Versions License Apache 2.0

Supported platforms

Should be compatible with at least Python +3.7.

Installing

pip install nats-py

Getting started

import asyncio
import nats
from nats.errors import ConnectionClosedError, TimeoutError, NoServersError

async def main():
    # It is very likely that the demo server will see traffic from clients other than yours.
    # To avoid this, start your own locally and modify the example to use it.
    nc = await nats.connect("nats://demo.nats.io:4222")

    # You can also use the following for TLS against the demo server.
    #
    # nc = await nats.connect("tls://demo.nats.io:4443")

    async def message_handler(msg):
        subject = msg.subject
        reply = msg.reply
        data = msg.data.decode()
        print("Received a message on '{subject} {reply}': {data}".format(
            subject=subject, reply=reply, data=data))

    # Simple publisher and async subscriber via coroutine.
    sub = await nc.subscribe("foo", cb=message_handler)

    # Stop receiving after 2 messages.
    await sub.unsubscribe(limit=2)
    await nc.publish("foo", b'Hello')
    await nc.publish("foo", b'World')
    await nc.publish("foo", b'!!!!!')

    # Synchronous style with iterator also supported.
    sub = await nc.subscribe("bar")
    await nc.publish("bar", b'First')
    await nc.publish("bar", b'Second')

    try:
        async for msg in sub.messages:
            print(f"Received a message on '{msg.subject} {msg.reply}': {msg.data.decode()}")
            await sub.unsubscribe()
    except Exception as e:
        pass

    async def help_request(msg):
        print(f"Received a message on '{msg.subject} {msg.reply}': {msg.data.decode()}")
        await nc.publish(msg.reply, b'I can help')

    # Use queue named 'workers' for distributing requests
    # among subscribers.
    sub = await nc.subscribe("help", "workers", help_request)

    # Send a request and expect a single response
    # and trigger timeout if not faster than 500 ms.
    try:
        response = await nc.request("help", b'help me', timeout=0.5)
        print("Received response: {message}".format(
            message=response.data.decode()))
    except TimeoutError:
        print("Request timed out")

    # Remove interest in subscription.
    await sub.unsubscribe()

    # Terminate connection to NATS.
    await nc.drain()

if __name__ == '__main__':
    asyncio.run(main())

JetStream

Starting v2.0.0 series, the client now has JetStream support:

import asyncio
import nats
from nats.errors import TimeoutError

async def main():
    nc = await nats.connect("localhost")

    # Create JetStream context.
    js = nc.jetstream()

    # Persist messages on 'foo's subject.
    await js.add_stream(name="sample-stream", subjects=["foo"])

    for i in range(0, 10):
        ack = await js.publish("foo", f"hello world: {i}".encode())
        print(ack)

    # Create pull based consumer on 'foo'.
    psub = await js.pull_subscribe("foo", "psub")

    # Fetch and ack messagess from consumer.
    for i in range(0, 10):
        msgs = await psub.fetch(1)
        for msg in msgs:
            await msg.ack()
            print(msg)

    # Create single ephemeral push based subscriber.
    sub = await js.subscribe("foo")
    msg = await sub.next_msg()
    await msg.ack()

    # Create single push based subscriber that is durable across restarts.
    sub = await js.subscribe("foo", durable="myapp")
    msg = await sub.next_msg()
    await msg.ack()

    # Create deliver group that will be have load balanced messages.
    async def qsub_a(msg):
        print("QSUB A:", msg)
        await msg.ack()

    async def qsub_b(msg):
        print("QSUB B:", msg)
        await msg.ack()
    await js.subscribe("foo", "workers", cb=qsub_a)
    await js.subscribe("foo", "workers", cb=qsub_b)

    for i in range(0, 10):
        ack = await js.publish("foo", f"hello world: {i}".encode())
        print("\t", ack)

    # Create ordered consumer with flow control and heartbeats
    # that auto resumes on failures.
    osub = await js.subscribe("foo", ordered_consumer=True)
    data = bytearray()

    while True:
        try:
            msg = await osub.next_msg()
            data.extend(msg.data)
        except TimeoutError:
            break
    print("All data in stream:", len(data))

    await nc.close()

if __name__ == '__main__':
    asyncio.run(main())

TLS

TLS connections can be configured with an ssl context

ssl_ctx = ssl.create_default_context(purpose=ssl.Purpose.SERVER_AUTH)
ssl_ctx.load_verify_locations('ca.pem')
ssl_ctx.load_cert_chain(certfile='client-cert.pem',
                        keyfile='client-key.pem')
await nats.connect(servers=["tls://127.0.0.1:4443"], tls=ssl_ctx, tls_hostname="localhost")

Setting the scheme to tls in the connect URL will make the client create a default ssl context automatically:

import asyncio
import ssl
from nats.aio.client import Client as NATS

async def run():
    nc = NATS()
    await nc.connect("tls://demo.nats.io:4443")

Note: If getting SSL certificate errors in OS X, try first installing the certifi certificate bundle. If using Python 3.7 for example, then run:

$ /Applications/Python\ 3.7/Install\ Certificates.command
 -- pip install --upgrade certifi
Collecting certifi
...
 -- removing any existing file or link
 -- creating symlink to certifi certificate bundle
 -- setting permissions
 -- update complete

NKEYS and JWT User Credentials

Since v0.9.0 release, you can also optionally install NKEYS in order to use the new NATS v2.0 auth features:

pip install nats-py[nkeys]

Usage:

await nats.connect("tls://connect.ngs.global:4222", user_credentials="/path/to/secret.creds")

Development

  1. Install nats server.
  2. Make sure the server is available in your PATH: nats-server -v.
  3. Install dependencies: python3 -m pipenv install --dev.
  4. Run tests: python3 -m pytest.

License

Unless otherwise noted, the NATS source files are distributed under the Apache Version 2.0 license found in the LICENSE file.

More Repositories

1

nats-server

High-Performance server for NATS.io, the cloud and edge native messaging system.
Go
14,523
star
2

nats.go

Golang client for NATS, the cloud native messaging system.
Go
5,149
star
3

nats-streaming-server

NATS Streaming System Server
Go
2,495
star
4

nats.js

Node.js client for NATS, the cloud native messaging system.
JavaScript
1,477
star
5

nats.rs

Rust client for NATS, the cloud native messaging system.
Rust
933
star
6

nats.rb

Ruby client for NATS, the cloud native messaging system.
Ruby
880
star
7

stan.go

NATS Streaming System
Go
705
star
8

nats.net

The official C# Client for NATS
C#
639
star
9

nats-operator

NATS Operator
Go
571
star
10

nats.java

Java client for NATS
Java
541
star
11

jetstream

JetStream Utilities
Dockerfile
452
star
12

k8s

NATS on Kubernetes with Helm Charts
Go
416
star
13

natscli

The NATS Command Line Interface
Go
414
star
14

nats.c

A C client for NATS
C
367
star
15

nuid

NATS Unique Identifiers
Go
357
star
16

prometheus-nats-exporter

A Prometheus exporter for NATS metrics
Go
344
star
17

nats-top

A top-like tool for monitoring NATS servers.
Go
331
star
18

stan.js

Node.js client for NATS Streaming
JavaScript
293
star
19

nats.ws

WebSocket NATS
JavaScript
290
star
20

nats-surveyor

NATS Monitoring, Simplified.
Go
204
star
21

nats.ex

Elixir client for NATS, the cloud native messaging system. https://nats.io
Elixir
189
star
22

nats.ts

TypeScript Node.js client for NATS, the cloud native messaging system
TypeScript
178
star
23

graft

A RAFT Election implementation in Go.
Go
176
star
24

nats-streaming-operator

NATS Streaming Operator
Go
173
star
25

nats.net.v2

Full Async C# / .NET client for NATS
C#
170
star
26

nats-architecture-and-design

Architecture and Design Docs
Go
164
star
27

nats.deno

Deno client for NATS, the cloud native messaging system
TypeScript
149
star
28

nack

NATS Controllers for Kubernetes (NACK)
Go
139
star
29

stan.net

The official NATS .NET C# Streaming Client
C#
137
star
30

jsm.go

JetStream Management Library for Golang
Go
132
star
31

nats-docker

Official Docker image for the NATS server
Dockerfile
123
star
32

nkeys

NATS Keys
Go
120
star
33

nats-pure.rb

Ruby client for NATS, the cloud native messaging system.
Ruby
117
star
34

nats-kafka

NATS to Kafka Bridging
Go
116
star
35

stan.py

Python Asyncio NATS Streaming Client
Python
113
star
36

nats.zig

Zig Client for NATS
109
star
37

go-nats-examples

Single repository for go-nats example code. This includes all documentation examples and any common message pattern examples.
Go
108
star
38

nginx-nats

NGINX client module for NATS, the cloud native messaging system.
C
105
star
39

nats.docs

NATS.io Documentation on Gitbook
HTML
103
star
40

nats-box

A container with NATS utilities
HCL
99
star
41

stan.java

NATS Streaming Java Client
Java
92
star
42

not.go

A reference for distributed tracing with the NATS Go client.
Go
91
star
43

nsc

Tool for creating nkey/jwt based configurations
Go
88
star
44

nats-site

Website content for https://nats.io. For technical issues with NATS products, please log an issue in the proper repository.
Markdown
87
star
45

jparse

Small, Fast, Compliant JSON parser that uses events parsing and index overlay
Java
86
star
46

elixir-nats

Elixir NATS client
Elixir
76
star
47

nats-account-server

A simple HTTP/NATS server to host JWTs for nats-server 2.0 account authentication.
Go
73
star
48

jwt

JWT tokens signed using NKeys for Ed25519 for the NATS ecosystem.
Go
71
star
49

nats.py2

A Tornado based Python 2 client for NATS
Python
62
star
50

nats-general

General NATS Information
61
star
51

spring-nats

A Spring Cloud Stream Binder for NATS
Java
58
star
52

terraform-provider-jetstream

Terraform Provider to manage NATS JetStream
Go
54
star
53

nats.cr

Crystal client for NATS
Crystal
44
star
54

nats-streaming-docker

Official Docker image for the NATS Streaming server
Python
44
star
55

nats-rest-config-proxy

NATS REST Configuration Proxy
Go
33
star
56

nats-connector-framework

A pluggable service to bridge NATS with other technologies
Java
32
star
57

demo-minio-nats

Demo of syncing across clouds with minio
Go
27
star
58

java-nats-examples

Repo for java-nats-examples
Java
26
star
59

asyncio-nats-examples

Repo for Python Asyncio examples
Python
25
star
60

stan.rb

Ruby NATS Streaming Client
Ruby
21
star
61

nats-mq

Simple bridge between NATS streaming and MQ Series
Go
21
star
62

jetstream-leaf-nodes-demo

Go
20
star
63

go-nats

[ARCHIVED] Golang client for NATS, the cloud native messaging system.
Go
20
star
64

nats-on-a-log

Raft log replication using NATS.
Go
20
star
65

nats-replicator

Bridge to replicate NATS Subjects or Channels to NATS Subject or Channels
Go
19
star
66

nkeys.js

NKeys for JavaScript - Node.js, Browsers, and Deno.
TypeScript
18
star
67

latency-tests

Latency and Throughput Test Framework
HCL
14
star
68

nats-jms-bridge

NATS to JMS Bridge for request/reply
Java
12
star
69

nats-connector-redis

A Redis Publish/Subscribe NATS Connector
Java
12
star
70

node-nuid

A Node.js implementation of NUID
JavaScript
10
star
71

nats-java-vertx-client

Java
10
star
72

nats.swift

Swift client for NATS, the cloud native messaging system.
Swift
10
star
73

sublist

History of the original sublist
Go
9
star
74

nkeys.py

NATS Keys for Python
Python
8
star
75

nats-siddhi-demo

A NATS with Siddhi Event Processing Reference Architecture
8
star
76

node-nats-examples

Documentation samples for node-nats
JavaScript
8
star
77

jwt.js

JWT tokens signed using nkeys for Ed25519 for the NATS JavaScript ecosystem
TypeScript
7
star
78

jetstream-gh-action

Collection of JetStream related Actions for GitHub Actions
Go
7
star
79

kubecon2020

Go
7
star
80

nats-spark-connector

Scala
7
star
81

java-nats-server-runner

Run the Nats Server From your Java code.
Java
6
star
82

kotlin-nats-examples

Repo for Kotlin Nats examples.
Kotlin
6
star
83

js-nuid

TypeScript
6
star
84

ts-nats-examples

typescript nats examples
TypeScript
5
star
85

go-nats-streaming

[ARCHIVED] NATS Streaming System
Go
5
star
86

integration-tests

Repository for integration test suites of any language
Java
5
star
87

homebrew-nats-tools

Repository hosting homebrew taps for nats-io tools
Ruby
5
star
88

ts-nkeys

A public-key signature system based on Ed25519 for the NATS ecosystem in typescript for ts-nats and node-nats
TypeScript
4
star
89

nats-steampipe-plugin

Example steampipe plugin for NATS
Go
4
star
90

nkeys.rb

NATS Keys for Ruby
Ruby
4
star
91

advisories

Advisories related to the NATS project
HTML
3
star
92

kinesis-bridge

Bridge Amazon Kinesis to NATS streams.
Go
3
star
93

not.java

A reference for distributed tracing with the NATS Java client.
Java
2
star
94

deploy

Deployment for NATS
Ruby
2
star
95

nats.c.deps

C
2
star
96

stan2js

NATS Streaming to JetStream data migration tool.
Go
2
star
97

netlify-slack

Trivial redirector website
1
star
98

cliprompts

cli prompt utils
Go
1
star
99

ruby-nats-examples

Repo for Ruby Examples
Ruby
1
star
100

nats-mendix

CSS
1
star