Skip to main content

Iris is a highly configurable and flexible service for paging and messaging.

Project description

Iris Build Status License Gitter chat

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

  1. remove ONLY_FULL_GROUP_BY from MySQL config sql_mode
  2. create mysql schema: mysql -u USER -p < ./db/schema_0.sql
  3. 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

  1. create & source your virtualenv
  2. install build dependencies: libssl-dev libxml2-dev libxslt1-dev libsasl2-dev python-dev libldap2-dev
  3. run pip install -e '.[dev,kazoo]'
  4. 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

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

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

irisapi-1.0.31.tar.gz (915.9 kB view details)

Uploaded Source

Built Distribution

irisapi-1.0.31-py3-none-any.whl (950.5 kB view details)

Uploaded Python 3

File details

Details for the file irisapi-1.0.31.tar.gz.

File metadata

  • Download URL: irisapi-1.0.31.tar.gz
  • Upload date:
  • Size: 915.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.9.1

File hashes

Hashes for irisapi-1.0.31.tar.gz
Algorithm Hash digest
SHA256 0de94264119b1a7095148d20fce3f394d1dd515c1e9f844be73f382a116cebbc
MD5 67e5f68e72af3720dc84b426afbd2134
BLAKE2b-256 a1c7571e0f3ffdb0e8152edf4982b8a2714ef277639d257105e97d7e04203e4b

See more details on using hashes here.

File details

Details for the file irisapi-1.0.31-py3-none-any.whl.

File metadata

  • Download URL: irisapi-1.0.31-py3-none-any.whl
  • Upload date:
  • Size: 950.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.9.1

File hashes

Hashes for irisapi-1.0.31-py3-none-any.whl
Algorithm Hash digest
SHA256 e3ee7eef1296ed0b256aa9268b4446f1f9584bf4bb48e3b42fdf7dc8002eaaa3
MD5 a584564dab2828af7e416df2d16e7fc9
BLAKE2b-256 5d4d313cd0c7a3d5529a469a9f1afb6adb2f19408e7dd145f1e1e6174778c35b

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