Restructure modules (#3)

restructure-modules: Rename src module to open_feature

Signed-off-by: Andrew Helsby <[email protected]>

Author: ajhelsby

.flake8

@@ -1,2 +1,3 @@
 [flake8]
-max-line-length = 88
+max-line-length = 88
+exclude = .venv/*,venv/*,.git,__pycache__

.github/workflows/build.yml

@@ -0,0 +1,53 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Test
+
+on:
+  push:
+    branches:
+      - '*'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        container: [ "python:3.8", "python:3.9", "python:3.10" ]
+    container:
+      image: ${{ matrix.container }}
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Cache virtualenvironment
+        uses: actions/cache@v2
+        with:
+          path: ~/.venv
+          key: ${{ hashFiles('requirements.txt', 'requirements-dev.txt') }}
+
+      - name: Upgrade pip
+        run: pip install --upgrade pip
+
+      - name: Create and activate Virtualenv
+        run: |
+          pip install virtualenv
+          [ ! -d ".venv" ] && virtualenv .venv
+          . .venv/bin/activate
+
+      - name: Install dependencies
+        run: pip install -r requirements-dev.txt
+
+      - name: Run black formatter check
+        run: black --check .
+
+      - name: Run flake8 formatter check
+        run: flake8 .
+
+      - name: Run isort formatter check
+        run: isort .
+
+      - name: Test with pytest
+        run: pytest

src/__init__.py renamed to open_feature/__init__.py

@@ -0,0 +1,87 @@
+from open_feature.flag_evaluation.error_code import ErrorCode
+
+
+class OpenFeatureError(Exception):
+    """
+    A generic open feature exception, this exception should not be raised. Instead
+    the more specific exceptions extending this one should be used.
+    """
+
+    def __init__(self, error_message: str = None, error_code: ErrorCode = None):
+        """
+        Constructor for the generic OpenFeatureError.
+        @param error_message: a string message representing why the error has been
+        raised
+        @param error_code: the ErrorCode string enum value for the type of error
+        @return: the generic OpenFeatureError exception
+        """
+        self.error_message = error_message
+        self.error_code = error_code
+
+
+class FlagNotFoundError(OpenFeatureError):
+    """
+    This exception should be raised when the provider cannot find a flag with the
+    key provided by the user.
+    """
+
+    def __init__(self, error_message: str = None):
+        """
+        Constructor for the FlagNotFoundError.  The error code for
+        this type of exception is ErrorCode.FLAG_NOT_FOUND.
+        @param error_message: a string message representing why the error has been
+        raised
+        @return: the generic FlagNotFoundError exception
+        """
+        super().__init__(error_message, ErrorCode.FLAG_NOT_FOUND)
+
+
+class GeneralError(OpenFeatureError):
+    """
+    This exception should be raised when the for an exception within the open
+    feature python sdk.
+    """
+
+    def __init__(self, error_message: str = None):
+        """
+        Constructor for the GeneralError.  The error code for this type of exception
+        is ErrorCode.GENERAL.
+        @param error_message: a string message representing why the error has been
+        raised
+        @return: the generic GeneralError exception
+        """
+        super().__init__(error_message, ErrorCode.GENERAL)
+
+
+class ParseError(OpenFeatureError):
+    """
+    This exception should be raised when the flag returned by the provider cannot
+    be parsed into a FlagEvaluationDetails object.
+    """
+
+    def __init__(self, error_message: str = None):
+        """
+        Constructor for the ParseError. The error code for this type of exception
+        is ErrorCode.PARSE_ERROR.
+        @param error_message: a string message representing why the error has been
+        raised
+        @return: the generic ParseError exception
+        """
+        super().__init__(error_message, ErrorCode.PARSE_ERROR)
+
+
+class TypeMismatchError(OpenFeatureError):
+    """
+    This exception should be raised when the flag returned by the provider does
+    not match the type requested by the user.
+    """
+
+    def __init__(self, error_message: str = None):
+        """
+        Constructor for the TypeMismatchError. The error code for this type of
+        exception is ErrorCode.TYPE_MISMATCH.
+        @param error_message: a string message representing why the error has been
+        raised
+        @return: the generic TypeMismatchError exception
+        """
+        super().__init__(error_message, ErrorCode.TYPE_MISMATCH)

src/evaluation_context/__init__.py renamed to open_feature/evaluation_context/__init__.py

@@ -1,5 +1,5 @@
-from src.flag_evaluation.error_code import ErrorCode
-from src.flag_evaluation.reason import Reason
+from open_feature.flag_evaluation.error_code import ErrorCode
+from open_feature.flag_evaluation.reason import Reason
 
 
 class FlagEvaluationDetails: