spartan-module-feature-flag

This module provides a flexible and standardized way to manage feature flags in Python applications. It supports PostgreSQL for persistent storage and optional Redis caching for improved performance.

Features

• CRUD Operations: Create, read, update, and delete feature flags.
• Database Support: PostgreSQL integration.
• Optional Redis Caching: Cache feature flag data for faster access. Redis integration is optional and can be omitted.
• Optional Slack Notifier: Send notification to a Slack channel.

Installation

To install the module and its dependencies, use:

poetry install

Usage

Example Usage

In the examples/basic-usage directory, you will find a complete example of how to use the Feature Flag module in a FastAPI application.

Slack Notifier

• Attributes

  • webhook_url: This attribute stores the Slack webhook URL used to send messages to the specified Slack channel.
  • excluded_statuses (Optional): This attribute is a list that specifies which status changes should not trigger notifications to the Slack channel.
    • If set to None, all status changes will trigger notifications.
  • headers (Optional): A dictionary where you can specify additional HTTP headers to include in the Slack notification requests.

• Sample Code

  slack_notifier = SlackNotifier(
    webhook_url='https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX',
    excluded_statuses=[ChangeStatus.DELETED, ChangeStatus,DISABLED],
    headers = {
      "Authorization": "Bearer xoxb-your-slack-token",
      "Content-Type": "application/json"
    }
  )
  

Development

Debugging & Fixing Issues:

Local Debugging: clone the module repository and install it in "editable" mode using pip install -e ..

Install

• To install the module and its dev dependencies, use:

  poetry install --with dev
  

Run docker-compose

• To run the PostgreSQL and Redis services, use:

  docker-compose -f docker-compose.ci.yml up -d
  

• To shut down the services, use:

  docker-compose -f docker-compose.ci.yml down
  

Testing

To run the tests, use:

• Unit tests:

  poetry run pytest tests/unit
  

• Integration tests:

  poetry run pytest tests/integration
  

• Or we can run all tests:

  poetry run pytest tests/
  

Release

Please follow guidelines in docs/RELEASE.md

Contributors

Duc Duong

Hao Bui

Tuong Dang