Package Health Score

54 / 100

security
Security review needed
popularity
Small
maintenance
Inactive
community
Sustainable

Popularity

Small

GitHub Stars: 810
Forks: 139
Contributors: 30

Direct Usage Popularity

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

Security

Security review needed

Security and license risk for latest version

Release Date: Nov 16, 2021
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
8
M
0
L

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

License

BSD-2-Clause

Security Policy

We found a way for you to contribute to the project! Looks like irisapi 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

Inactive

Commit Frequency

Open Issues: 38
Open PR: 9
Last Release: 3 years ago
Last Commit: 10 months ago

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

An important project maintenance signal to consider for irisapi is that it hasn't seen any new versions released to PyPI in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Sustainable

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

With more than 10 contributors for the irisapi 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 irisapi 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: 5 years
Latest Release: 3 years ago
Dependencies: 31 Direct / 67 Total
Versions: 41
Maintainers: 2
Wheels: OS Independent

Readme

Iris

Iris core, API, UI and sender service. For third-party integration support, see iris-relay, a stateless proxy designed to sit at the edge of a production network and allow external traffic to pass through. We also have an Iris mobile app for iOS/Android, at the iris-mobile repo.

Setup database

remove ONLY_FULL_GROUP_BY from MySQL config sql_mode or run mysqld in permisive mode (i.e. --sql_mode='')
create mysql schema: mysql -u USER -p < ./db/schema_0.sql (WARNING: This will drop any existing tables)
import dummy data: mysql -u USER -p -o iris < ./db/dummy_data.sql

dummy_data.sql contains the following entities:

user demo with password demo
team demo_team
application Autoalerts with key: a7a9d7657ac8837cd7dfed0b93f4b8b864007724d7fa21422c24f4ff0adb2e49

Setup dev environment

create & source your virtualenv
install build dependencies: libssl-dev libxml2-dev libxslt1-dev libsasl2-dev python-dev libldap2-dev
run pip install -e '.[dev,kazoo]'
edit ./configs/config.dev.yaml to setup database credential and other settings

To install iris with extra features, you can pass in feature flag with pip:

pip install -e '.[prometheus]'

For list of extra features, please see extras_require setting in setup.py.

Run everything

forego start

Run web server

make serve

Run sender

iris-sender configs/config.dev.yaml

Tests

Run tests:

make test  # all tests, e2e + unit
make e2e  # e2e tests
make unit  # unit tests

Generate test coverage reports:

make e2e-cov
make unit-cov

Adding new plugins

create the plugin file under src/iris/plugins dir
edit src/iris/plugins/__init__.py to add plugin module to __all__ list

FAQs

What is irisapi?

Iris is a highly configurable and flexible service for paging and messaging. Visit Snyk Advisor to see a full health score report for irisapi, including popularity, security, maintenance & community analysis.

Is irisapi popular?

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

Is irisapi well maintained?

We found indications that irisapi is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is irisapi safe to use?

While scanning the latest version of irisapi, 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 1 November-2024, at 15:03 (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

irisapi

Iris is a highly configurable and flexible service for paging and messaging. For more information about how to use this package see README

Ensure you're using the healthiest python packages

Package Health Score

Popularity

Direct Usage Popularity

Security

Security and license risk for latest version

Maintenance

Commit Frequency

Community

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Package

Readme

Iris

Setup database

Setup dev environment

Run everything

Run web server

Run sender

Tests

Adding new plugins

irisapi dependencies

FAQs

What is irisapi?

Is irisapi popular?

Is irisapi well maintained?

Is irisapi safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Readme

Iris

Setup database

Setup dev environment

Run everything

Run web server

Run sender

Tests

Adding new plugins

irisapi dependencies

FAQs

What is irisapi?

Is irisapi popular?

Is irisapi well maintained?

Is irisapi safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues