Introduction
Le nom Apprise (/əˈpraɪz/) se prononce comme « uh-prise », un peu comme surprise ou arise, avec l’accent sur la deuxième syllabe.
Apprise est un routeur de notifications. Vous décrivez chaque destination sous forme d’URL, vous confiez un message à Apprise, et il le remet à toutes les destinations indiquées.
Apprise ne remplace pas votre plateforme de discussion, votre fournisseur de messagerie ni votre système d’alerte. Il se place devant eux, pour que vous n’ayez qu’une seule façon d’envoyer un message à apprendre.
Que vous lanciez des tâches cron, gériez des conteneurs ou développiez des applications, Apprise vous évite d’apprendre et de maintenir une API différente pour chaque service.
Une Syntaxe pour Toutes les Gouverner
Section intitulée « Une Syntaxe pour Toutes les Gouverner »Au cœur d’Apprise se trouve l’URL Universelle de Notification.
Au lieu d’apprendre un format de charge utile propre à chaque service, vous configurez vos destinations à l’aide d’une syntaxe unique, prévisible et cohérente :
service://credentials/direction/?parameter=valueChanger de service plus tard revient à modifier l’URL, pas votre code ni vos scripts.
Les notifications restent ainsi portables, maintenables et faciles à raisonner.
Comment Apprise s’Articule
Section intitulée « Comment Apprise s’Articule »- Quelque chose doit envoyer un message. Un script, un webhook, la ligne de commande, l’application mobile, ou un logiciel qui parle déjà Apprise.
- Apprise se charge de la remise. Vous importez la bibliothèque Python dans votre propre code, ou vous exécutez le serveur API comme passerelle partagée vers laquelle n’importe quoi peut poster.
- Le message part. Une seule requête peut atteindre une destination ou toutes celles que vous avez configurées, en parallèle.
Comme le format d’URL est le même partout, une URL testée en ligne de commande fonctionne telle quelle dans un script, dans le serveur API ou sur votre téléphone.
À quoi ça ressemble
Section intitulée « À quoi ça ressemble »Depuis un script ou la ligne de commande :
apprise -t "Sauvegarde terminée" -b "Le serveur est sain et sauf" \ "discord://webhook_id/webhook_token"Ou depuis votre propre code Python :
import apprise
apobj = apprise.Apprise()apobj.add("tgram://credentials")
apobj.notify( body="Bonjour le monde", title="Ma notification",)Les deux envoient la même notification. Pour viser un autre service, seule l’URL change.
Fonctionnalités Clés
Section intitulée « Fonctionnalités Clés »- 162 services pris en charge, des plateformes de discussion populaires aux passerelles spécialisées
- Diffusion adaptée au format, y compris Markdown, HTML et texte brut
- Prise en charge des pièces jointes, automatiquement adaptée aux capacités de chaque service
- Haute performance, avec envoi parallèle des notifications
- Dépendances minimales, afin de rester léger
Par Où Commencer
Section intitulée « Par Où Commencer »| Si vous voulez… | Utilisez… |
|---|---|
| Notifier depuis des tâches cron, des scripts ou la CI | La CLI |
| Envoyer des notifications depuis votre application | La Bibliothèque Python |
| Offrir une passerelle de notifications partagée à vos systèmes | Le Serveur API, sans état ou avec configurations enregistrées |
| Envoyer depuis votre téléphone vers votre serveur auto-hébergé | Apprise Mobile |
Questions ou commentaires ?
Documentation
Vous avez repéré une faute de frappe ou une erreur ?
Problèmes Techniques
Vous rencontrez un problème avec le code ? Ouvrez un ticket sur GitHub :