Skip to main content

Python SDK for Hoopoe

Project description


Logo Python

Hoopoe Python

Python SDK for Hoopoe | Get notified of what's important
Explore the docs »

View Demo · Report Bug · Request Feature

About The Project

Hoopoe is a platform that helps you notify yourself when something important happens in your platform!

Getting Started

There's two ways to use hoopoe, either you can user Hoopoe.app or host it yourself.

Installation

  1. Get a free API Key at https://hoopoe.app
  2. Install NPM packages
    pip install hoopoe-python
    

Usage

First import hoopoe-python and create an instance of it.

from hoopoe-python import Hoopoe 

hoopoe = new Hoopoe({
    api_key: 'your_hoopoe_api_key',
    version: '1', # API version, default 1
    base_url: 'https://...', # self-hosted only 
})

Then you can send a notification to yourself using like this:

hoopoe.upupa("Your message here", extra = {
    "extra": "info",
    "could": "be",
    "added": "here",
})

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

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/amazing-feature)
  3. Commit your Changes (git commit -m 'Add some amazing-feature')
  4. Push to the Branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hoopoe-python-0.0.2.tar.gz (3.0 kB view details)

Uploaded Source

Built Distribution

hoopoe_python-0.0.2-py3-none-any.whl (3.6 kB view details)

Uploaded Python 3

File details

Details for the file hoopoe-python-0.0.2.tar.gz.

File metadata

  • Download URL: hoopoe-python-0.0.2.tar.gz
  • Upload date:
  • Size: 3.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.10

File hashes

Hashes for hoopoe-python-0.0.2.tar.gz
Algorithm Hash digest
SHA256 0b24b3dd8deccecdadca71f2b5534d383f35801574a0c1842888212aaab32d12
MD5 99663c9f53ccee08aa6a7c9adbd79109
BLAKE2b-256 6d134e8dcc5ad33650967421370878a77a4625cbe41e696ab3584d15e343a272

See more details on using hashes here.

File details

Details for the file hoopoe_python-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: hoopoe_python-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 3.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.10

File hashes

Hashes for hoopoe_python-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3111a718ed2069c784829aa17e07195f49f4a91ae4f44c1dad6d21a13e24df49
MD5 69ec454a06496720b0b527f52b8bdb17
BLAKE2b-256 dd330f9381a8b6dd856fa61840dc0dda2bfa5149f2d4cb4995eaccd124785522

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page