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.24.tar.gz (914.6 kB view details)

Uploaded Source

Built Distribution

irisapi-1.0.24-py3-none-any.whl (948.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: irisapi-1.0.24.tar.gz
  • Upload date:
  • Size: 914.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for irisapi-1.0.24.tar.gz
Algorithm Hash digest
SHA256 57148e5b23f32626d2647aa5926a6bc537f704b32701bf23d6e9f38af11a819e
MD5 b7d9ff8490d7b0f960c31637cf8ec6b8
BLAKE2b-256 e40716d85a84fe097e1d00459233c6b7a98ab8efac93a3219f39ea122f9901d3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: irisapi-1.0.24-py3-none-any.whl
  • Upload date:
  • Size: 948.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for irisapi-1.0.24-py3-none-any.whl
Algorithm Hash digest
SHA256 4ab05e8120535aced0d449204df0773e7b87d2ab122c5f45a35476ce9e558067
MD5 5a075201af65f5399788a1a61ee40fa2
BLAKE2b-256 9216da26c9823aac4378232e1bcdbbe4ed46b406e2cef998b91c3cdcdaf59c01

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