instagis/cb-integrator repository overview

⁠Civic Brain Integrator

⁠Project Dashboard

⁠Development

⁠Hosting

⁠Monitoring

⁠Logs

⁠Miscellaneous

• Asana Projects:
  • CB Integrator⁠
  • CB Web API⁠
  • CB Event Store⁠
  • CB Data Flow⁠

⁠Technical Requirements

• Python 3.5
• Apache Kafka: Event Store queue and database.
• Apache ZooKeeper: Used for coordination between Kafka nodes.
• Redis: Cache store.

⁠Directory Structure

• .circleci/: CircleCI 2.0 configuration.
• bin/: Scripts and utilities.
• docs/: Documentation.
• ig_cb_app_view/: Civic Brain App View.
• ig_cb_events/: Civic Brain Events.
• ig_cb_handlers/: Civic Brain Handlers.
• ig_cb_integrator/: Civic Brain Integrator.
  • config/: Configuration.
  • handlers/
    • system/: System handlers.
  • lib/
  • tests/: Tests.
• ig_cb_lib/: Civic Brain Common Library.
• ig_cb_web_api/: Civic Brain Web API.
  • cb_subjects/: Civic Brain Subjects API.
  • config/: Configuration.
  • events/: Generic Event API.
  • lib/
  • main/
  • tests/: Tests.
• make/: Make task definitions.
• schemas/: Entity schemas.
  • events/: Event Data schemas.
• zrm_model/: ZRM Model.

⁠Development

Always activate the virtualenv before running any command.

⁠Linting

Run make lint.

⁠Testing

Run make test.

⁠Test Coverage

Run make test-coverage.

⁠Documentation

For more information, including configuration and usage instructions, read the documentation⁠.