Skip to main content

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 or run mysqld in permisive mode (i.e. --sql_mode='')
  2. create mysql schema: mysql -u USER -p < ./db/schema_0.sql (WARNING: This will drop any existing tables)
  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

Release files for irisapi 1.0.37

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for irisapi 1.0.37
File Size Uploaded
irisapi-1.0.37.tar.gz 922.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for irisapi 1.0.37
File Interpreter ABI Platform
irisapi-1.0.37-py3-none-any.whl Python 3 none any Details

Total release size: 1.9 MB

Release files / irisapi-1.0.37.tar.gz

Download URL irisapi-1.0.37.tar.gz
Size 922.0 kB
Tags Source
SHA-256 checksum
How to use checksums
835b5be0ad265b6f38dd64c8b30a99b95696c4d20a73da12c8cfd9aa8c583595
BLAKE2b-256 checksum
How to use checksums
7fc12e899767e64ce6945478e3241a51b177e3fb5d2131e87326f917a5c401db
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

Release files / irisapi-1.0.37-py3-none-any.whl

Download URL irisapi-1.0.37-py3-none-any.whl
Size 953.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f0d60e151d556a2ec1a38725a14bf5ee4e51d279d0535bcf61810c04b72571b8
BLAKE2b-256 checksum
How to use checksums
12fa96d15d5a08fdb7943a2a8ce02cec5d0a5caa188c727dd9c1c235494ee45c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

Release history Release notifications | RSS feed

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page