This SDK provides convenient access to the MagicBell REST API from applications written in Python. It includes helpers for creating notifications, managing users, managing projects, and executing GraphQL.
This is an unofficial Python SDK for MagicBell open sourced with ❤️ by Noteable, a collaborative notebook platform that enables teams to use and visualize data, together.
Install | Getting Started | Examples | License | Code of Conduct | Contributing
Python 3.8+
poetry add magicbell
Then import the package:
import magicbell
pip install magicbell
Then import the package:
import magicbell
import magicbell
from magicbell.configuration import Configuration
config = Configuration(
api_key="YOUR_API_KEY",
api_secret="YOUR_API_SECRET",
)
async with magicbell.MagicBell(config) as mb:
# Send a notification
await mb.realtime.create_notification(
magicbell.WrappedNotification(
notification=magicbell.Notification(
title="My first notification from python!",
recipients=[magicbell.Recipient(email="dan@example.com")],
)
)
)
Most API calls require your MagicBell project API Key and API Secret. Some API calls (i.e. projects) require your MagicBell user JWT (enterprise only).
See the MagicBell API documentation for more information.
Configuration can be done explicitly using the magicbell.Configuration
class,
or implicitly by setting environment variables with the MAGICBELL_
prefix.
from magicbell.configuration import Configuration
# Create a configuration object with the required parameters
config = Configuration(
api_key="YOUR_API_KEY",
api_secret="YOUR_API_SECRET",
)
export MAGICBELL_API_KEY="YOUR_API_KEY"
export MAGICBELL_API_SECRET="YOUR_API_SECRET"
from magicbell.configuration import Configuration
config = Configuration()
For more examples see the examples
directory.
See CONTRIBUTING.md.
Open sourced with ❤️ by Noteable for the community.