ntfy-jupyter 0.1.1

No project description provided

Notify Jupyter (ntfy.sh)

ntfy-jupyter is a very simple IPython extension that allows you to send notifications using the ntfy service. Ntfy is an open source service which makes subscribing and sending notifications super easy. This library helps you keep track your notebook tasks and results, sending notifications upon cell execution or failure.

Table of Contents

• Installation
• Usage
• Configuration
• Development
• Contributing
• License

Installation

To install ntfy-jupyter, use Poetry or pip.

Using Poetry

1. Clone the repository:

   git clone https://github.com/vali101/ntfy-jupyter
   cd ntfy-jupyter
   

2. Install dependencies:

   poetry install
   

Using pip

Alternatively, you can install ntfy-jupyter directly from PyPI:

pip install ntfy-jupyter

Usage

To use this extension you need to install ntfy on your preferred device. Then subscribe to your own custom channel, all channels are private but you can e.g. append a secret to make them pseudo-private. You can use the utility function like:

from ntfy_jupyter import create_topic

topic = create_topic('alerts') # e.g. -> alerts-zHgv2B6LCd8nCkNoj18p9j

To create a topic-channel with secret. Then in a jupyter notebook just load the extension via:

%load_ext ntfy_jupyter

Use the notify magic command to get infos about cell execution or errors:

%%notify -t your_topic -m "Your message" -e -i
# Your cell code here

• -t or --topic: The topic for the notification.
• -m or --message: The message to send. Defaults to an empty message.
• -e or --errors: Include error details in the notification if the cell fails.
• -i or --include: Include the cell code in the notification.

Development

To contribute to the development of ntfy-jupyter, follow these steps:

1. Clone the Repository:

   git clone https://github.com/yourusername/ntfy-jupyter.git
   cd ntfy-jupyter
   

2. Set Up Development Environment:

   poetry install
   

3. Make Your Changes and submit a pull request.

For detailed contribution guidelines, refer to CONTRIBUTING.md.

Contributing

We welcome contributions to ntfy-jupyter. Please follow these guidelines:

• Fork the Repository: Create your own fork of the repository.
• Create a Branch: Make a new branch for your changes.
• Submit a Pull Request: Provide a clear description of your changes.

Please ensure your code adheres to the project's style guide and passes all tests.

License

ntfy-jupyter is licensed under the MIT License. See LICENSE for more details.