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

Uploaded Source

Built Distribution

irisapi-1.0.19-py3-none-any.whl (948.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: irisapi-1.0.19.tar.gz
  • Upload date:
  • Size: 914.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.2

File hashes

Hashes for irisapi-1.0.19.tar.gz
Algorithm Hash digest
SHA256 cb30e7370b0f37ee38715fbb589a409b4e0363ef74c917704ed7a2425ed8e313
MD5 7162749223482bed883eacc59beaeac1
BLAKE2b-256 10ed25a29613ce84f24ceb9f7bf5dffc4360c379a066281576074987b6ba64f8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: irisapi-1.0.19-py3-none-any.whl
  • Upload date:
  • Size: 948.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.2

File hashes

Hashes for irisapi-1.0.19-py3-none-any.whl
Algorithm Hash digest
SHA256 fabc89fc4d654285e07bb55a23c805c5d4b61f9490ebfcfc12c270bc39acf0e3
MD5 2b59bf3296d1ddfaa7d9c2328c5b2e1c
BLAKE2b-256 0b97859ea415f6f6b2b18e9ae8498e6a11cd30d45987019b7e230a7ff8ceb841

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