novu-py

Developer-friendly & type-safe Python SDK specifically catered to leverage novu-py API.

Important

This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

Novu API: Novu REST API. Please see https://docs.novu.co/api-reference for more details.

For more information about the API: Novu Documentation

SDK Installation

The SDK can be installed with either pip or poetry package managers.

PIP

PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.

pip install novu-py

Poetry

Poetry is a modern tool that simplifies dependency management and package publishing by using a single pyproject.toml file to handle project metadata and dependencies.

poetry add novu-py

IDE Support

PyCharm

Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.

PyCharm Pydantic Plugin

SDK Example Usage

Trigger Notification Event

# Synchronous Example
import novu_py
from novu_py import Novu
import os

with Novu(
    api_key=os.getenv("NOVU_API_KEY", ""),
) as novu:

    res = novu.trigger(request=novu_py.TriggerEventRequestDto(
        name="workflow_identifier",
        to={
            "subscriber_id": "<id>",
        },
        payload={
            "comment_id": "string",
            "post": {
                "text": "string",
            },
        },
        bridge_url="https://example.com/bridge",
        overrides={
            "fcm": {
                "data": {
                    "key": "value",
                },
            },
        },
    ))

    # Handle response
    print(res)

The same SDK client can also be used to make asychronous requests by importing asyncio.

# Asynchronous Example
import asyncio
import novu_py
from novu_py import Novu
import os

async def main():
    async with Novu(
        api_key=os.getenv("NOVU_API_KEY", ""),
    ) as novu:

        res = await novu.trigger_async(request=novu_py.TriggerEventRequestDto(
            name="workflow_identifier",
            to={
                "subscriber_id": "<id>",
            },
            payload={
                "comment_id": "string",
                "post": {
                    "text": "string",
                },
            },
            bridge_url="https://example.com/bridge",
            overrides={
                "fcm": {
                    "data": {
                        "key": "value",
                    },
                },
            },
        ))

        # Handle response
        print(res)

asyncio.run(main())

Trigger Notification Events in Bulk

# Synchronous Example
import novu_py
from novu_py import Novu
import os

with Novu(
    api_key=os.getenv("NOVU_API_KEY", ""),
) as novu:

    res = novu.trigger_bulk(request={
        "events": [
            novu_py.TriggerEventRequestDto(
                name="workflow_identifier",
                to={
                    "subscriber_id": "<id>",
                },
                payload={
                    "comment_id": "string",
                    "post": {
                        "text": "string",
                    },
                },
                bridge_url="https://example.com/bridge",
                overrides={
                    "fcm": {
                        "data": {
                            "key": "value",
                        },
                    },
                },
            ),
            novu_py.TriggerEventRequestDto(
                name="workflow_identifier",
                to=[
                    {
                        "topic_key": "<value>",
                        "type": novu_py.TriggerRecipientsTypeEnum.SUBSCRIBER,
                    },
                ],
                payload={
                    "comment_id": "string",
                    "post": {
                        "text": "string",
                    },
                },
                bridge_url="https://example.com/bridge",
                overrides={
                    "fcm": {
                        "data": {
                            "key": "value",
                        },
                    },
                },
            ),
            novu_py.TriggerEventRequestDto(
                name="workflow_identifier",
                to=[
                    "SUBSCRIBER_ID",
                    "SUBSCRIBER_ID",
                ],
                payload={
                    "comment_id": "string",
                    "post": {
                        "text": "string",
                    },
                },
                bridge_url="https://example.com/bridge",
                overrides={
                    "fcm": {
                        "data": {
                            "key": "value",
                        },
                    },
                },
            ),
        ],
    })

    # Handle response
    print(res)

The same SDK client can also be used to make asychronous requests by importing asyncio.

# Asynchronous Example
import asyncio
import novu_py
from novu_py import Novu
import os

async def main():
    async with Novu(
        api_key=os.getenv("NOVU_API_KEY", ""),
    ) as novu:

        res = await novu.trigger_bulk_async(request={
            "events": [
                novu_py.TriggerEventRequestDto(
                    name="workflow_identifier",
                    to={
                        "subscriber_id": "<id>",
                    },
                    payload={
                        "comment_id": "string",
                        "post": {
                            "text": "string",
                        },
                    },
                    bridge_url="https://example.com/bridge",
                    overrides={
                        "fcm": {
                            "data": {
                                "key": "value",
                            },
                        },
                    },
                ),
                novu_py.TriggerEventRequestDto(
                    name="workflow_identifier",
                    to=[
                        {
                            "topic_key": "<value>",
                            "type": novu_py.TriggerRecipientsTypeEnum.SUBSCRIBER,
                        },
                    ],
                    payload={
                        "comment_id": "string",
                        "post": {
                            "text": "string",
                        },
                    },
                    bridge_url="https://example.com/bridge",
                    overrides={
                        "fcm": {
                            "data": {
                                "key": "value",
                            },
                        },
                    },
                ),
                novu_py.TriggerEventRequestDto(
                    name="workflow_identifier",
                    to=[
                        "SUBSCRIBER_ID",
                        "SUBSCRIBER_ID",
                    ],
                    payload={
                        "comment_id": "string",
                        "post": {
                            "text": "string",
                        },
                    },
                    bridge_url="https://example.com/bridge",
                    overrides={
                        "fcm": {
                            "data": {
                                "key": "value",
                            },
                        },
                    },
                ),
            ],
        })

        # Handle response
        print(res)

asyncio.run(main())

Broadcast Event to All

# Synchronous Example
from novu_py import Novu
import os

with Novu(
    api_key=os.getenv("NOVU_API_KEY", ""),
) as novu:

    res = novu.trigger_broadcast(request={
        "name": "<value>",
        "payload": {
            "comment_id": "string",
            "post": {
                "text": "string",
            },
        },
    })

    # Handle response
    print(res)

The same SDK client can also be used to make asychronous requests by importing asyncio.

# Asynchronous Example
import asyncio
from novu_py import Novu
import os

async def main():
    async with Novu(
        api_key=os.getenv("NOVU_API_KEY", ""),
    ) as novu:

        res = await novu.trigger_broadcast_async(request={
            "name": "<value>",
            "payload": {
                "comment_id": "string",
                "post": {
                    "text": "string",
                },
            },
        })

        # Handle response
        print(res)

asyncio.run(main())

Cancel Triggered Event

# Synchronous Example
from novu_py import Novu
import os

with Novu(
    api_key=os.getenv("NOVU_API_KEY", ""),
) as novu:

    res = novu.cancel(transaction_id="<id>")

    # Handle response
    print(res)

The same SDK client can also be used to make asychronous requests by importing asyncio.

# Asynchronous Example
import asyncio
from novu_py import Novu
import os

async def main():
    async with Novu(
        api_key=os.getenv("NOVU_API_KEY", ""),
    ) as novu:

        res = await novu.cancel_async(transaction_id="<id>")

        # Handle response
        print(res)

asyncio.run(main())

Available Resources and Operations

Available methods

integrations

list - Get integrations
create - Create integration
list_active - Get active integrations
update - Update integration
delete - Delete integration
set_as_primary - Set integration as primary

integrations.webhooks

retrieve - Get webhook support status for provider

messages

retrieve - Get messages
delete - Delete message
delete_by_transaction_id - Delete messages by transactionId

notifications

list - Get notifications
retrieve - Get notification

notifications.stats

retrieve - Get notification statistics
graph - Get notification graph statistics

Novu SDK

trigger - Trigger event
trigger_bulk - Bulk trigger event
trigger_broadcast - Broadcast event to all
cancel - Cancel triggered event
support_controller_fetch_user_organizations
create

subscribers

list - Get subscribers
create - Create subscriber
retrieve - Get subscriber
update - Update subscriber
delete - Delete subscriber
create_bulk - Bulk create subscribers

subscribers.authentication

chat_access_oauth_call_back - Handle providers oauth redirect
chat_access_oauth - Handle chat oauth

subscribers.credentials

update - Update subscriber credentials
append - Modify subscriber credentials
delete - Delete subscriber credentials by providerId

subscribers.messages

mark_all_as - Mark a subscriber messages as seen, read, unseen or unread
mark_all - Marks all the subscriber messages as read, unread, seen or unseen. Optionally you can pass feed id (or array) to mark messages of a particular feed.
update_as_seen - Mark message action as seen

subscribers.notifications

feed - Get in-app notification feed for a particular subscriber
unseen_count - Get the unseen in-app notifications count for subscribers feed

subscribers.preferences

list - Get subscriber preferences
update_global - Update subscriber global preferences
retrieve_by_level - Get subscriber preferences by level
update - Update subscriber preference

subscribers.properties

update_online_flag - Update subscriber online status

topics

create - Topic creation
list - Get topic list filtered
delete - Delete topic
retrieve - Get topic
rename - Rename a topic

topics.subscribers

assign - Subscribers addition
retrieve - Check topic subscriber
remove - Subscribers removal

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will have a Next method that can be called to pull down the next group of results. If the return value of Next is None, then there are no more pages to be fetched.

Here's an example of one such pagination call:

from novu_py import Novu
import os

with Novu(
    api_key=os.getenv("NOVU_API_KEY", ""),
) as novu:

    res = novu.subscribers.list()

    while res is not None:
        # Handle items

        res = res.next()

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a RetryConfig object to the call:

import novu_py
from novu_py import Novu
from novu_py.utils import BackoffStrategy, RetryConfig
import os

with Novu(
    api_key=os.getenv("NOVU_API_KEY", ""),
) as novu:

    res = novu.trigger(request=novu_py.TriggerEventRequestDto(
        name="workflow_identifier",
        to={
            "subscriber_id": "<id>",
        },
        payload={
            "comment_id": "string",
            "post": {
                "text": "string",
            },
        },
        bridge_url="https://example.com/bridge",
        overrides={
            "fcm": {
                "data": {
                    "key": "value",
                },
            },
        },
    ),
        RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

    # Handle response
    print(res)

If you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config optional parameter when initializing the SDK:

import novu_py
from novu_py import Novu
from novu_py.utils import BackoffStrategy, RetryConfig
import os

with Novu(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
    api_key=os.getenv("NOVU_API_KEY", ""),
) as novu:

    res = novu.trigger(request=novu_py.TriggerEventRequestDto(
        name="workflow_identifier",
        to={
            "subscriber_id": "<id>",
        },
        payload={
            "comment_id": "string",
            "post": {
                "text": "string",
            },
        },
        bridge_url="https://example.com/bridge",
        overrides={
            "fcm": {
                "data": {
                    "key": "value",
                },
            },
        },
    ))

    # Handle response
    print(res)

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.

By default, an API error will raise a models.APIError exception, which has the following properties:

Property	Type	Description
`.status_code`	int	The HTTP status code
`.message`	str	The error message
`.raw_response`	httpx.Response	The raw HTTP response
`.body`	str	The response content

When custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the trigger_async method may raise the following exceptions:

Error Type	Status Code	Content Type
models.ErrorDto	400, 404, 409	application/json
models.ValidationErrorDto	422	application/json
models.APIError	4XX, 5XX	/

Example

import novu_py
from novu_py import Novu, models
import os

with Novu(
    api_key=os.getenv("NOVU_API_KEY", ""),
) as novu:
    res = None
    try:

        res = novu.trigger(request=novu_py.TriggerEventRequestDto(
            name="workflow_identifier",
            to={
                "subscriber_id": "<id>",
            },
            payload={
                "comment_id": "string",
                "post": {
                    "text": "string",
                },
            },
            bridge_url="https://example.com/bridge",
            overrides={
                "fcm": {
                    "data": {
                        "key": "value",
                    },
                },
            },
        ))

        # Handle response
        print(res)

    except models.ErrorDto as e:
        # handle e.data: models.ErrorDtoData
        raise(e)
    except models.ValidationErrorDto as e:
        # handle e.data: models.ValidationErrorDtoData
        raise(e)
    except models.APIError as e:
        # handle exception
        raise(e)

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the server_idx: int optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

#	Server
0	`https://api.novu.co`
1	`https://eu.api.novu.co`

Example

import novu_py
from novu_py import Novu
import os

with Novu(
    server_idx=1,
    api_key=os.getenv("NOVU_API_KEY", ""),
) as novu:

    res = novu.trigger(request=novu_py.TriggerEventRequestDto(
        name="workflow_identifier",
        to={
            "subscriber_id": "<id>",
        },
        payload={
            "comment_id": "string",
            "post": {
                "text": "string",
            },
        },
        bridge_url="https://example.com/bridge",
        overrides={
            "fcm": {
                "data": {
                    "key": "value",
                },
            },
        },
    ))

    # Handle response
    print(res)

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:

import novu_py
from novu_py import Novu
import os

with Novu(
    server_url="https://api.novu.co",
    api_key=os.getenv("NOVU_API_KEY", ""),
) as novu:

    res = novu.trigger(request=novu_py.TriggerEventRequestDto(
        name="workflow_identifier",
        to={
            "subscriber_id": "<id>",
        },
        payload={
            "comment_id": "string",
            "post": {
                "text": "string",
            },
        },
        bridge_url="https://example.com/bridge",
        overrides={
            "fcm": {
                "data": {
                    "key": "value",
                },
            },
        },
    ))

    # Handle response
    print(res)

Custom HTTP Client

The Python SDK makes API calls using the httpx HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance. Depending on whether you are using the sync or async version of the SDK, you can pass an instance of HttpClient or AsyncHttpClient respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls. This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of httpx.Client or httpx.AsyncClient directly.

For example, you could specify a header for every request that this sdk makes as follows:

from novu_py import Novu
import httpx

http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = Novu(client=http_client)

or you could wrap the client with your own custom logic:

from novu_py import Novu
from novu_py.httpclient import AsyncHttpClient
import httpx

class CustomClient(AsyncHttpClient):
    client: AsyncHttpClient

    def __init__(self, client: AsyncHttpClient):
        self.client = client

    async def send(
        self,
        request: httpx.Request,
        *,
        stream: bool = False,
        auth: Union[
            httpx._types.AuthTypes, httpx._client.UseClientDefault, None
        ] = httpx.USE_CLIENT_DEFAULT,
        follow_redirects: Union[
            bool, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
    ) -> httpx.Response:
        request.headers["Client-Level-Header"] = "added by client"

        return await self.client.send(
            request, stream=stream, auth=auth, follow_redirects=follow_redirects
        )

    def build_request(
        self,
        method: str,
        url: httpx._types.URLTypes,
        *,
        content: Optional[httpx._types.RequestContent] = None,
        data: Optional[httpx._types.RequestData] = None,
        files: Optional[httpx._types.RequestFiles] = None,
        json: Optional[Any] = None,
        params: Optional[httpx._types.QueryParamTypes] = None,
        headers: Optional[httpx._types.HeaderTypes] = None,
        cookies: Optional[httpx._types.CookieTypes] = None,
        timeout: Union[
            httpx._types.TimeoutTypes, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
        extensions: Optional[httpx._types.RequestExtensions] = None,
    ) -> httpx.Request:
        return self.client.build_request(
            method,
            url,
            content=content,
            data=data,
            files=files,
            json=json,
            params=params,
            headers=headers,
            cookies=cookies,
            timeout=timeout,
            extensions=extensions,
        )

s = Novu(async_client=CustomClient(httpx.AsyncClient()))

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme	Environment Variable
`api_key`	apiKey	API key	`NOVU_API_KEY`

To authenticate with the API the api_key parameter must be set when initializing the SDK client instance. For example:

import novu_py
from novu_py import Novu
import os

with Novu(
    api_key=os.getenv("NOVU_API_KEY", ""),
) as novu:

    res = novu.trigger(request=novu_py.TriggerEventRequestDto(
        name="workflow_identifier",
        to={
            "subscriber_id": "<id>",
        },
        payload={
            "comment_id": "string",
            "post": {
                "text": "string",
            },
        },
        bridge_url="https://example.com/bridge",
        overrides={
            "fcm": {
                "data": {
                    "key": "value",
                },
            },
        },
    ))

    # Handle response
    print(res)

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass your own logger class directly into your SDK.

from novu_py import Novu
import logging

logging.basicConfig(level=logging.DEBUG)
s = Novu(debug_logger=logging.getLogger("novu_py"))

You can also enable a default debug logger by setting an environment variable NOVU_DEBUG to true.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

Name		Name	Last commit message	Last commit date
Latest commit History 3 Commits
.devcontainer		.devcontainer
.github/workflows		.github/workflows
.idea		.idea
.speakeasy		.speakeasy
.vscode		.vscode
docs		docs
scripts		scripts
src/novu_py		src/novu_py
.gitattributes		.gitattributes
.gitignore		.gitignore
CONTRIBUTING.md		CONTRIBUTING.md
README.md		README.md
RELEASES.md		RELEASES.md
USAGE.md		USAGE.md
poetry.lock		poetry.lock
poetry.toml		poetry.toml
py.typed		py.typed
pylintrc		pylintrc
pyproject.toml		pyproject.toml

novuhq/novu-py

Folders and files

Latest commit

History

Repository files navigation

novu-py

Summary

Table of Contents

SDK Installation

PIP

Poetry

IDE Support

PyCharm

SDK Example Usage

Trigger Notification Event

Trigger Notification Events in Bulk

Broadcast Event to All

Cancel Triggered Event

Available Resources and Operations

Pagination

Retries

Error Handling

Example

Server Selection

Select Server by Index

Example

Override Server URL Per-Client

Custom HTTP Client

Authentication

Per-Client Security Schemes

Debugging

Development

Maturity

Contributions

SDK Created by Speakeasy

About

Resources

Stars

Watchers

Forks

Languages