swannotificationsservice

v1.0.1

JupyterHub service to expose notifications for Jupyter For more information about how to use this package see README

Latest version published 3 months ago

License: AGPL-3.0

PyPI

GitHub

Package Health Score

57 / 100

security
Security review needed
popularity
Limited
maintenance
Sustainable
community
Limited

Popularity

Limited

GitHub Stars: 25
Forks: 13
Contributors: 20

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package swannotificationsservice, we found that it has been starred 25 times.

Security

Security review needed

Security and license risk for latest version

Release Date: Aug 28, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 1
H
4
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

AGPL-3.0

Non-Permissive License

We noticed that this project uses a license which requires less permissive conditions such as disclosing the source code, stating changes or redistributing the source under the same license. It is advised to further consult the license terms before use.

Security Policy

We found a way for you to contribute to the project! Looks like swannotificationsservice is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Sustainable

Commit Frequency

Open Issues: 12
Open PR: 1
Last Release: 3 months ago
Last Commit: 2 months ago

Further analysis of the maintenance status of swannotificationsservice based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that swannotificationsservice demonstrates a positive version release cadence with at least one new version released in the past 3 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Limited

Readme: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the swannotificationsservice repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like swannotificationsservice is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: ==3.*

Age: 4 years
Latest Release: 3 months ago
Dependencies: 0 Direct
Versions: 4
Maintainers: 1
Wheels: OS Independent

Readme

SwanNotificationsService

JupyterHub service that exposes an API with notifications for the logged in user. The notifications are specified in a json file. If a "maintenance file" exists, a notification will be given that the service is under maintenance.

This extension works in conjunction with SwanNotifications.

Requirements

This module requires and installs JupyterHub.

Installation

Install the package:

pip install swannotificationsservice

Update the container image

This folder contains a Dockerfile that can be used to create an image for the pod that runs the notifications service. Once you release to PyPI you need to create a new image, e.g.

docker build -t gitlab-registry.cern.ch/swan/docker-images/jupyterhub/notifications:v0.1.0 && docker push gitlab-registry.cern.ch/swan/docker-images/jupyterhub/notifications:v0.1.0

Usage

Call the binary and specify configuration parameters:

swannotificationsservice --notifications_file /srv/jupyterhub/notifications.json

Configuration parameters:

port (default: 8888)
notifications_file (default: /srv/jupyterhub/notifications.json)
maintenance_file (default: /etc/nologin)
prefix (default: /)

Notifications file example:

[
    {
        "user": "*",
        "id": "notif1",
        "level": "info",
        "dismissible": 0,
        "message": "This is a notification"
    }
]

Explanation:

user: username or '*' for all users;
id: unique identifier;
level: type of the notification (notice, info, success, or error)
dismissible: wether the user will be able to permanently hide the notification (0 or 1)
message: the text/html message

FAQs

What is swannotificationsservice?

JupyterHub service to expose notifications for Jupyter. Visit Snyk Advisor to see a full health score report for swannotificationsservice, including popularity, security, maintenance & community analysis.

Is swannotificationsservice popular?

The python package swannotificationsservice receives a total of 43 weekly downloads. As such, swannotificationsservice popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is swannotificationsservice well maintained?

We found indications that swannotificationsservice maintenance is sustainable demonstrating some project activity. We saw a total of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is swannotificationsservice safe to use?

While scanning the latest version of swannotificationsservice, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 21 November-2024, at 11:01 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP