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

Uploaded Source

Built Distribution

irisapi-1.0.30-py3-none-any.whl (949.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: irisapi-1.0.30.tar.gz
  • Upload date:
  • Size: 915.3 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.0 CPython/3.9.1

File hashes

Hashes for irisapi-1.0.30.tar.gz
Algorithm Hash digest
SHA256 f81a8e399614d94748bf02eace2600836122584cc9f40a543d3e34ab14a4af51
MD5 dced166ceba68b35c34ddb06aca73bb9
BLAKE2b-256 6631f564e6b836bec9648dae37a6f4c57de6a7988dfd9fca83e8565d24b85a45

See more details on using hashes here.

File details

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

File metadata

  • Download URL: irisapi-1.0.30-py3-none-any.whl
  • Upload date:
  • Size: 949.8 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.0 CPython/3.9.1

File hashes

Hashes for irisapi-1.0.30-py3-none-any.whl
Algorithm Hash digest
SHA256 1811ab8b9188126f6980b4703b17011bf81e9dd8b923e547dbae6b99cca1dd0d
MD5 db555be2cabf012b40fbd9e6d339af31
BLAKE2b-256 37e95f7c085659cb6c73e735f23797c0b7373c5026775fbfb94c03881b31ada1

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