Package: tattler
🚩 Table of contents👀 What is tattler?🤩 Examples🚀 Quick start💙 Help us be better🎖️ License📈 Enterprise users📌 Links👀 What is tattler?Are you building an online service and need to send beautiful, branded notifications via email or SMS to your users?Tattler makes that easy for you. Your application makes a simple HTTP call to tattler:curl-XPOST'http://127.0.0.1:11503/notification/mywebapp/password_changed/?user=123'Tattler helps you with these:Templates: Load templates for eventpassword_changedfor email, SMS etc.Addressbook: Fetch the user’s email address and mobile number from your DB (with trivial-to-write plug-ins).Template data: Fetch variables for your templates from your DB (with trivial-to-write plug-ins).MIME: Package a multi-part email with HTML+text fallback.Delivery: Send the content through SMTP and an SMS delivery network.Dev mode: Let your applications trigger notifications to the real user and have tattler only deliver it to your debug address.Tattler is designed with simplicity in mind. It strives to be easy to adopt and useful among common needs – so you
can focus on your communication, brand and customer journey.If your system sends notifications from multiple different softwares – say a web application, a billing daemon,
and a cron job which monitors inventory – then your simplification gains with tattlers get multipled 🚀😵‍💫 Don’t beat around the bush!Tattler is:a serverwritten in pythonfor UNIX systemsthat exposes a REST interfacewhich your applications contactto request delivery of notifications to users.🤩 ExamplesHere’s a little gallery of notifications sent via tattler to email and SMS:Fig 1. Example notification as HTML email.Fig 2. Its corresponding plain text version.Fig 3. Tattler’s demo notification with reusable code samples.Fig 4. A SMS notification.🚀 Quick startInstall tattler:# create and load a virtualenv to install intomkdir~/tattler_quickstartpython3-mvenv~/tattler_quickstart/venv.~/tattler_quickstart/venv/bin/activate# install tattler into itpipinstalltattlerRun tattler server:exportTATTLER_MASTER_MODE=production# if you need to customize your SMTP settingsexportTATTLER_SMTP_ADDRESS="127.0.0.1:25"exportTATTLER_SMTP_AUTH="username:password"# you will learn secure configuration laterexportTATTLER_SMTP_TLS=yes# run tattler server on default 127.0.0.1:11503tattler_serverTrigger a demo notification via HTTP:# in a new terminal:# replace ``your@email.com`` with your actual email addresscurl-XPOST'http://127.0.0.1:11503/notification/demoscope/demoevent/?mode=production&user=your@email.com'… or via command-line utility:# load the same virtual environment where you installed tattler server.~/tattler_quickstart/venv/bin/activate# replace ``your@email.com`` with your actual email addresstattler_notify-s'127.0.0.1:11503'-mproductionyour@email.comdemoscopedemoevent… or via tattler’s python SDK:fromtattler.client.tattler_pyimportsend_notification# replace ``your@email.com`` with your actual email addresssend_notification('demoscope','demoevent','your@email.com',mode='production',srv_addr='127.0.0.1',srv_port=11503)Done!Want more? Proceed to thecomplete quickstartin tattler’s documentation
for plug-ins, deployment and more.💙 Help us be betterHere’s how you can help, in order of increasing time commitment 🙂⭐️ star ourrepositoryif you like tattler. That’s our go-to place whenever we feel sad! 😁Let us knowthat you are using tattler. How long? For what organization? What is your feedback?Let your friends know about tattler. If you found it useful, chances are they will too.Report anyissuein our code or docs. We take those seriously.Package tattler for your distribution.See ways to contribute in ourcontributing guidelines.🎖️ LicenseTattler is open-source software (BSD 3-clause license).📈 Enterprise usersTattler isenterprise-friendly. Enterprise users avail of a
subscription which provides a bugfixing warranty, extra features, and patronage for the continuity
of the project.📌 LinksTattler websiteDocumentationHTTP API specRepository