Hoopoe - Get notified of important stuff, right away.

Overview

Logo

Hoopoe - Get notified of important stuff, right away.

Report a Bug · Request a Feature . Ask a Question

license

PRs welcome made with hearth by thevahidal

Table of Contents

About

There are some important stuff that we must be aware of, like when they exceed some sort of limits or when they start setting fire to your house. In the company that I work, we had this burning desire for a system that send us alert when some stuff happens, right away. As you already know the only thing that we always carry around is our phones, so we thought what is better than getting a notification in those cases! That's why I started this project, it's supposed to help us and anyone else dealing with these kind of issues.

Hoopoe is meant to be real straight forward, when you want get notified of a certain thing, just call Hoopoe and Hoopoe make sure to send you a notification.

    # In your code...
    if that_thing_happened:
        hoopoe.call("The thing that we don't like happened!", extra={
            "where": "Alex's House",
            "type": "Cops",
            "how_bad": "4/5"
        })

    
    # And right away in your inbox...
    # Hoopoe Upupa | New Notification: The thing that we don't like happened!
    
    # When
    # Thu, Dec 23, 2021, 09:17 PM UTC
    # Info
    # {
    #   "where": "Alex's House",
    #   "type": "Cops",
    #   "how_bad": "4/5"
    # }

NOTICE: This snippet is imaginary.

Key features of Hoopoe:

  • Instant notifications

  • Support for email

  • Support for popular messengers (Coming Soon!)

    • Whatsapp
    • Telegram
    • Slack
    • ...
  • Lots of SDKs (Coming Soon!)

    • Python
    • Javascript
    • ...
  • Cloud (Coming Soon!) and on-premise

Why Hoopoe? The story behind the name.

Looking for a name that's both beautiful and meaningful, I started to google for ancient gods and heroes that are somehow related to delivering messages. There were some candidates but Hermes was the leading one, but since it's used so many times decided to go with another one, which ended up with Hoopoe. Hoopoe served King Solomon as a delivery man (animal?), so I thought why not! It's a cute animal and the name sticks!

Getting Started

Prerequisites

The recommended way to use Hoopoe is by using Hoopoe.app which take away the pain of deploying and maintaining Hoopoe on your own (Coming Soon!). For manual usage please refer to manual setup section.

Cloud vs. On-premise

Hoopoe core is a RESTful API. Either you're using the Hoopoe.app or your own deployment, you can refer to API docs (Coming Soon!) to read more about APIs.

Manual setup

There are two ways to deploy Hoopoe:

  1. Using docker image (Recommended) (Coming Soon!)
  2. Manual deployment, you can use this awesome article by Digitalocean on how to deploy a django project to production environment
    • Please make sure to serve your deployment over HTTPS (Important)

    • This project is actively updating, make sure to update your deployment often

    • Duplicate .env_, rename it to .env and fill the required environment variables See here

          cp .env_ .env
          nano .env

Environment Variables reference

Please note that entered values are case-sensitive. Default values are provided as an example to help you figure out what should be entered. As mentioned in manual setup section, you need to duplicate .env_, rename it to .env and fill the required environment variables.

Name Default (Example) Description
SECRET_KEY None Django Secret Key
DEBUG True Make sure to use DEBUG: False in production
EMAIL_HOST None (mail.example.com) Mail server host (Required for email driver)
EMAIL_HOST_USER None ([email protected]) Email address for sending emails
EMAIL_HOST_PASSWORD None Password for previous email
EMAIL_PORT 587 Mail server port
EMAIL_USE_TLS TRUE Email TLS
EMAIL_UPUPA_USER None ([email protected]) We use this email to send notifications
EMAIL_UPUPA_PASSWORD None Password for previous email
DJANGO_ALLOWED_HOSTS localhost 127.0.0.1 [::1] Django allowed hosts (Space separated)
SQL_ENGINE django.db.backends.postgresql DB Engine
SQL_DATABASE hoopoe_dev DB Name
SQL_USER hoopoe DB User
SQL_PASSWORD hoopoe DB User Password
SQL_HOST localhost DB Host
SQL_PORT 5432 DB Port
REDIS_HOST localhost Redis Host
REDIS_PORT 6379 Redis Port

Roadmap

See the open issues for a list of proposed features (and known issues).

  • Lots of SDKs
    • Python
    • Javascript
    • Cli
    • ...
  • Support for popular messengers
    • Telegram
    • Whatsapp
    • Slack ...

Contributing

First off, thanks for taking the time to contribute! Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

Please try to create bug reports that are:

  • Reproducible. Include steps to reproduce the problem.
  • Specific. Include as much detail as possible: which version, what environment, etc.
  • Unique. Do not duplicate existing opened issues.
  • Scoped to a Single Bug. One bug per report.

Please adhere to this project's code of conduct.

Support

Reach out to the maintainer at one of the following places:

License

This project is licensed under the MIT license.

See LICENSE for more information.

Acknowledgements

Thanks for Amazing GitHub template for the awesome README and code of conduct that saved me a lot of hours:

You might also like...
Encode stuff with ducks!

Duckify Encoder Usage Download main.py and run it. main.py has an encoded version in encoded_main.py.txt. As A Module Download the duckify folder (or

addons to the turtle package that help you drew stuff more quickly

TurtlePlus addons to the turtle package that help you drew stuff more quickly --------------

A discord group chat creator just made it because i saw people selling this stuff for like up to 40 bucks

gccreator some discord group chat tools just made it because i saw people selling this stuff for like up to 40 bucks (im currently working on a faster

A working roblox account generator it doesnt bypass the capcha stuff cuz these didnt showed up in my test runs
A working roblox account generator it doesnt bypass the capcha stuff cuz these didnt showed up in my test runs

A working roblox account generator (state 11.5.2021) it doesnt bypass the capcha stuff cuz these didnt showed up in my test runs

Mines all the moneys and stuff and things.

NFT Miner NFT Miner - Version 1.1.0 - Quick Fix Since the whole NFT thing started booming on Twitter it's been hard not to see one of those ugly ass m

Python script to commit to your github for a perfect commit streak. This is purely for education purposes, please don't use this script to do bad stuff.

Daily-Git-Commit Commit to repo every day for the perfect commit streak Requirments pip install -r requirements.txt Setup Download this repository. Cr

Ikaros is a free financial library built in pure python that can be used to get information for single stocks, generate signals and build prortfolios

Ikaros is a free financial library built in pure python that can be used to get information for single stocks, generate signals and build prortfolios

Chicks get hostloc points regularly

hostloc_getPoints 小鸡定时获取hostloc积分 github action大规模失效,mjj平均一人10鸡,以下可以部署到自己的小鸡上

Daily knowledge pills to get better in Python.

Python daily pills Daily knowledge pills to get better Python code. Why Does your Python code suffers of any of this symptoms? Incorrect Indentation I

Comments
  • idea use apprise instead of telegram

    idea use apprise instead of telegram

    This would also allow other targets to be supported with almost no additional code.

    • https://github.com/caronc/apprise-api
    • https://github.com/caronc/apprise
    enhancement 
    opened by clach04 1
Releases(v0.2.7)
Owner
Vahid Al
Software Developer
Vahid Al
Advent of Code 2021 challenges

Data analysis Document here the project: AoC21 Description: Project Description Data Source: Type of analysis: Please document the project the better

Daniel Wendel 1 Jan 07, 2022
Zues Auto Claimer Leaked By bazooka#0001

Zues Auto Claimer Leaked By bazooka#0001 put proxies in prox.txt put ssid in sid.txt put all users you want to target in user.txt for the login just t

1 Jan 15, 2022
Assignment for python course, BUPT 2021.

pyFuujinrokuDestiny Assignment for python course, BUPT 2021. Notice username and password must be ASCII encoding. If username exists in database, syst

Ellias Kiri Stuart 3 Jun 18, 2021
redun aims to be a more expressive and efficient workflow framework

redun yet another redundant workflow engine redun aims to be a more expressive and efficient workflow framework, built on top of the popular Python pr

insitro 372 Jan 04, 2023
Convert three types of color in your clipboard and paste it to the color property (gamma correct)

ColorPaster [Blender Addon] Convert three types of color in your clipboard and paste it to the color property (gamma correct) How to Use Hover your mo

13 Oct 31, 2022
Improving the Transferability of Adversarial Examples with Resized-Diverse-Inputs, Diversity-Ensemble and Region Fitting

Improving the Transferability of Adversarial Examples with Resized-Diverse-Inputs, Diversity-Ensemble and Region Fitting

Junhua Zou 7 Oct 20, 2022
Free version of Okuru selfbot, okuru.xyz

Indigo Selfbot Free OpenSource selfbot, Premium version can be found at https://okuru.xyz (5$.) Usage python[3] main.py Installation To install you ca

Dimitri Demarkus 31 Aug 07, 2022
Script to change official Kali repository to mirrors

Script to change official Kali repository to mirrors. This helps increase packages update and downloading for some user.

Vineet Bhavsar 2 Nov 29, 2021
An application for automation of the mining function in the game Alienworlds.IO

alienautomation A Python script made to automate the tidious job of mining on AlienWorlds This script: Automatically opens the browser Automatically l

anonieXdev 42 Dec 03, 2022
Superset custom path for python

It is a common requirement to have superset running under a base url, (https://mydomain.at/analytics/ instead of https://mydomain.at/). I created the

9 Dec 14, 2022
Serverless demo showing users how they can capture (and obfuscate) their Lambda payloads in Datadog APM

Serverless-capture-lambda-payload-demo Serverless demo showing users how they can capture (and obfuscate) their Lambda payloads in Datadog APM This wi

Datadog, Inc. 1 Nov 02, 2021
This repository requires you to solve a problem by writing some basic python code.

Can You Solve a Problem? A beginner friendly repository that requires you to solve familiar problems with python. This could be as simple as implement

Precious Kolawole 11 Nov 30, 2022
World's best free and open source ERP.

World's best free and open source ERP.

Frappe 12.5k Jan 07, 2023
Library to emulate the Sneakers movie effect

py-sneakers Port to python of the libnms C library To recreate the famous data decryption effect shown in the 1992 film Sneakers. Install pip install

Nicolas Rebagliati 11 Aug 27, 2021
Mdisk - 🚧 On Construction 🚧

Mdisk Install For Package pip install mdisk pip install git+https://github.com/HeimanPictures/Mdisk.git Usage You can use this as python module or via

AkKiL 6 Aug 08, 2022
PwnDatas-DB-Project(PDDP)

PwnDatas-DB-Project PwnDatas-DB-Project(PDDP) 安裝依賴: pip3 install pymediawiki 使用: cd /opt git https://github.com/JustYoomoon/PwnDatas-DB-Project.git c

21 Jul 16, 2021
Just RESTing

petnica-api-workshop Just RESTing Setup Using pipenv You can setup this project with pipenv if you want isolated libraries. After you've installed pip

Aleksa Tešić 1 Oct 23, 2021
Jannik Ramrath 1 Feb 05, 2022
This is a simple leaderboard for 30 days of Google Cloud program for students of ASIET

30daysleaderboard #Hacktoberfest - Please don't make changes in readme file. Only improvement in the project will be accepted. Update - Now if you run

5 Oct 29, 2021
🏆 A ranked list of awesome Python open-source libraries and tools. Updated weekly.

Best-of Python 🏆 A ranked list of awesome Python open-source libraries & tools. Updated weekly. This curated list contains 230 awesome open-source pr

Machine Learning Tooling 2.7k Jan 03, 2023