mindbridge-api-python-client 1.6.2__tar.gz → 1.8.0__tar.gz

mindbridge_api_python_client-1.8.0/.gitignore

@@ -0,0 +1,186 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Other IDEs
+.vscode/
+.project
+.pydevproject
+dask-worker-space/
+
+# macOS
+.DS_Store
+
+# Aider (https://aider.chat/)
+.aider*

{mindbridge_api_python_client-1.6.2 → mindbridge_api_python_client-1.8.0}/PKG-INFO

@@ -1,30 +1,25 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: mindbridge-api-python-client
-Version: 1.6.2
+Version: 1.8.0
 Summary: Interact with the MindBridge API
-License: LicenseRef-Proprietary
+Project-URL: Homepage, https://www.mindbridge.ai
+Author-email: MBAI Support <mbaisupport@mindbridge.ai>
+Maintainer-email: MBAI Support <mbaisupport@mindbridge.ai>
+License-Expression: LicenseRef-Proprietary
+License-File: LICENSE.txt
 Keywords: MindBridge
-Author: MBAI Support
-Author-email: mbaisupport@mindbridge.ai
-Maintainer: MBAI Support
-Maintainer-email: mbaisupport@mindbridge.ai
-Requires-Python: >= 3.9
 Classifier: Development Status :: 4 - Beta
-Classifier: Framework :: Pydantic
-Classifier: Framework :: Pydantic :: 2
-Classifier: Framework :: Pytest
-Classifier: License :: Other/Proprietary License
 Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Typing :: Typed
-Requires-Dist: pydantic (>=2.5.2,<3.0.0)
-Requires-Dist: urllib3 (>=2.3.0,<3.0.0)
-Project-URL: Homepage, https://www.mindbridge.ai
+Requires-Python: >=3.9
+Requires-Dist: pydantic>=2.8.1
+Requires-Dist: urllib3>=2.2.2
 Description-Content-Type: text/markdown
 
 <h1 align="center">MindBridge API Python Client</h1>
@@ -43,7 +38,7 @@ python -m pip install mindbridge-api-python-client
 
 ## Usage
 Replace `subdomain.mindbridge.ai` with your MindBridge tenant URL.
-```python
+```py
 import getpass
 import mindbridgeapi as mbapi
 
@@ -57,4 +52,3 @@ organization = server.organizations.create(organization)
 
 # Create engagements, analyses and run them, etc.
 ```
-

{mindbridge_api_python_client-1.6.2 → mindbridge_api_python_client-1.8.0}/README.md

@@ -14,7 +14,7 @@ python -m pip install mindbridge-api-python-client
 
 ## Usage
 Replace `subdomain.mindbridge.ai` with your MindBridge tenant URL.
-```python
+```py
 import getpass
 import mindbridgeapi as mbapi
 

mindbridge_api_python_client-1.8.0/pyproject.toml

@@ -0,0 +1,195 @@
+[build-system]
+build-backend = "hatchling.build"
+requires = [ "hatchling" ]
+
+[project]
+name = "mindbridge-api-python-client"
+description = "Interact with the MindBridge API"
+readme = "README.md"
+keywords = [ "MindBridge" ]
+license = "LicenseRef-Proprietary"
+license-files = [ "LICENSE.txt" ]
+maintainers = [
+    { name = "MBAI Support", email = "mbaisupport@mindbridge.ai" },
+]
+authors = [
+    { name = "MBAI Support", email = "mbaisupport@mindbridge.ai" },
+]
+requires-python = ">=3.9"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Typing :: Typed",
+]
+dynamic = [ "version" ]
+dependencies = [
+    "pydantic>=2.8.1",
+    "urllib3>=2.2.2",
+]
+urls.Homepage = "https://www.mindbridge.ai"
+
+[dependency-groups]
+dev = [
+    { include-group = "docs" },
+    { include-group = "lint" },
+    { include-group = "model" },
+    { include-group = "test" },
+    { include-group = "type" },
+]
+test = [
+    "openpyxl>=3.1.5",
+    "pandas>=2.2.3",
+    "pytest>=8.1.1",
+    "pytest-cov>=6.0.0",
+    "pytest-html>=4.1.1",
+    "pytest-randomly>=3.15.0",
+    { include-group = "model" },
+]
+type = [
+    "mypy>=1.13.0",
+    { include-group = "model" },
+]
+docs = [
+    "mkdocs-material>=9.6.4",
+    "mkdocstrings-python>=1.15.0",
+]
+lint = [
+    "ruff>=0.10.0",
+]
+model = [
+    "datamodel-code-generator[ruff]>=0.31.0",
+]
+
+[tool.hatch]
+version.path = "src/mindbridgeapi/version.py"
+build.targets.wheel.packages = [ "src/mindbridgeapi" ]
+build.targets.sdist.only-include = [ "src/mindbridgeapi" ]
+
+[tool.ruff]
+extend-exclude = [
+    ".cci_pycache",
+    "src/mindbridgeapi/generated_pydantic_model/model.py",
+]
+
+[tool.ruff.format]
+line-ending = "lf"
+skip-magic-trailing-comma = true
+docstring-code-format = true
+
+[tool.ruff.lint]
+select = [ "ALL" ]
+ignore = [
+    # flake8-clean-block = "^0.1.2"
+    # flake8-encodings = "^0.5.1" https://github.com/astral-sh/ruff/issues/3278
+    "ANN401", # Dynamically typed expressions (typing.Any) are disallowed in `...`
+    "CPY001", # Missing copyright notice at top of file
+    "D1",     # Missing docstring...
+    "FA",     # flake8-future-annotations
+    "SLF001", # Private member accessed
+    # When using Ruff as a formatter, we recommend avoiding the following lint rules:
+    "W191",   # tab-indentation (W191)
+    "E111",   # indentation-with-invalid-multiple (E111)
+    "E114",   # indentation-with-invalid-multiple-comment (E114)
+    "E117",   # over-indented (E117)
+    "D206",   # docstring-tab-indentation (D206)
+    "D300",   # triple-single-quotes (D300)
+    "Q000",   # bad-quotes-inline-string (Q000)
+    "Q001",   # bad-quotes-multiline-string (Q001)
+    "Q002",   # bad-quotes-docstring (Q002)
+    "Q003",   # avoidable-escaped-quote (Q003)
+    "COM812", # missing-trailing-comma (COM812)
+    "COM819", # prohibited-trailing-comma (COM819)
+    # multi-line-implicit-string-concatenation (ISC002) if used without ISC001 and flake8-implicit-str-concat.allow-multiline = false
+]
+per-file-ignores."tests/**.py" = [
+    "ANN",     # flake8-annotations (ANN)
+    "ARG001",  # Unused function argument: `...`
+    "ARG002",  # Unused method argument: `...`
+    "DOC",     # pydoclint (DOC)
+    "PLR6301", #  Method `...` could be a function, class method, or static method
+    "S101",    # Use of `assert` detected
+]
+flake8-builtins.ignorelist = [ "id", "type" ]
+flake8-tidy-imports.ban-relative-imports = "all"
+isort.combine-as-imports = true
+isort.force-sort-within-sections = true
+isort.no-lines-before = [ "first-party", "future", "local-folder", "standard-library", "third-party" ]
+isort.split-on-trailing-comma = false
+pydocstyle.convention = "google"
+
+[tool.pytest.ini_options]
+addopts = [
+    "--strict-config",
+    "--strict-markers",
+    "--cov=mindbridgeapi",
+    "--cov=generate_model",
+    "--cov=set_circleci_pytest_enviroment_variables",
+    "--cov-report=html",
+    "--cov-report=term",
+]
+xfail_strict = true
+filterwarnings = [ "error" ]
+pythonpath = [ "tools" ]
+
+[tool.coverage]
+run.branch = true
+run.data_file = ".coverage-reports/.coverage"
+run.omit = [ "src/mindbridgeapi/generated_pydantic_model/*" ]
+report.exclude_also = [
+    "if TYPE_CHECKING:",
+    'if __name__ == "__main__":',
+]
+
+[tool.mypy]
+mypy_path = "$MYPY_CONFIG_FILE_DIR/src"
+packages = "mindbridgeapi,tools.generate_model,tools.set_circleci_pytest_enviroment_variables"
+plugins = [ "pydantic.mypy" ]
+strict = true
+no_implicit_optional = true
+show_error_codes = true
+
+[tool.uv]
+python-downloads = "never"
+python-preference = "only-system"
+
+[tool.pydantic-mypy]
+init_forbid_extra = true
+init_typed = true
+warn_required_dynamic_aliases = true
+
+[tool.datamodel-codegen]
+formatters = [ "ruff-format", "ruff-check" ]
+input-file-type = "openapi"
+output-model-type = "pydantic_v2.BaseModel"
+# Typing customization:
+field-constraints = true
+use-annotated = true
+use-standard-collections = true
+use-subclass-enum = true
+# Field customization:
+capitalise-enum-members = true
+force-optional = true
+snake-case-field = true
+# Model customization:
+allow-population-by-field-name = true
+disable-timestamp = true
+output-datetime-class = "AwareDatetime"
+target-python-version = "3.9"
+use-schema-description = true
+# Template customization:
+custom-file-header = """\
+#
+#  Copyright MindBridge Analytics Inc. all rights reserved.
+#
+#  This material is confidential and may not be copied, distributed,
+#  reversed engineered, decompiled or otherwise disseminated without
+#  the prior written consent of MindBridge Analytics Inc.
+#"""
+encoding = "utf-8"
+use-double-quotes = true

{mindbridge_api_python_client-1.6.2 → mindbridge_api_python_client-1.8.0}/src/mindbridgeapi/__init__.py

@@ -12,13 +12,11 @@ from mindbridgeapi.analysis_period import AnalysisPeriod
 from mindbridgeapi.analysis_source_item import AnalysisSourceItem
 from mindbridgeapi.analysis_source_type_item import AnalysisSourceTypeItem
 from mindbridgeapi.analysis_type_item import AnalysisTypeItem
+from mindbridgeapi.api_token_item import ApiTokenItem, ApiTokenPermission
 from mindbridgeapi.chunked_file_item import ChunkedFileItem
 from mindbridgeapi.chunked_file_part_item import ChunkedFilePartItem
 from mindbridgeapi.column_mapping import ColumnMapping
 from mindbridgeapi.engagement_item import EngagementItem
-from mindbridgeapi.enumerations.analysis_source_type import AnalysisSourceType
-from mindbridgeapi.enumerations.analysis_type import AnalysisType
-from mindbridgeapi.enumerations.system_library import SystemLibrary
 from mindbridgeapi.file_manager_item import FileManagerItem, FileManagerType
 from mindbridgeapi.generated_pydantic_model.model import (
     Frequency,
@@ -33,18 +31,21 @@ from mindbridgeapi.transaction_id_selection import (
     TransactionIdSelection,
     TransactionIdType,
 )
+from mindbridgeapi.user_item import UserItem, UserRole
+from mindbridgeapi.version import VERSION
 from mindbridgeapi.virtual_column import VirtualColumn, VirtualColumnType
 
+__version__ = VERSION
 __all__ = [
     "AccountingPeriod",
     "AnalysisEffectiveDateMetricsPeriod",
     "AnalysisItem",
     "AnalysisPeriod",
     "AnalysisSourceItem",
-    "AnalysisSourceType",
     "AnalysisSourceTypeItem",
-    "AnalysisType",
     "AnalysisTypeItem",
+    "ApiTokenItem",
+    "ApiTokenPermission",
     "ChunkedFileItem",
     "ChunkedFilePartItem",
     "ColumnMapping",
@@ -55,13 +56,14 @@ __all__ = [
     "LibraryItem",
     "OrganizationItem",
     "Server",
-    "SystemLibrary",
     "TargetWorkflowState",
     "TaskItem",
     "TaskStatus",
     "TaskType",
     "TransactionIdSelection",
     "TransactionIdType",
+    "UserItem",
+    "UserRole",
     "VirtualColumn",
     "VirtualColumnType",
 ]

{mindbridge_api_python_client-1.6.2 → mindbridge_api_python_client-1.8.0}/src/mindbridgeapi/account_grouping_item.py

@@ -17,7 +17,7 @@ from mindbridgeapi.common_validators import (
 from mindbridgeapi.generated_pydantic_model.model import (
     ApiAccountGroupingRead,
     ApiAccountGroupingUpdate,
-    Type7 as _AccountGroupingFileType,
+    Type37 as _AccountGroupingFileType,
 )
 
 # Match the type of ApiImportAccountGroupingParamsCreateOnly.type:
@@ -25,10 +25,13 @@ AccountGroupingFileType = _AccountGroupingFileType
 
 
 def _empty_account_groups() -> Generator[AccountGroupItem, None, None]:
-    """Empty generator function
+    """Empty generator function.
 
     This returns an empty generator function, it's use is to ensure account_groups is
     not None for the AccountGroupingItem class
+
+    Yields:
+        AccountGroupItem: Will never yield anything
     """
     yield from ()
 

{mindbridge_api_python_client-1.6.2 → mindbridge_api_python_client-1.8.0}/src/mindbridgeapi/account_groupings.py

@@ -69,7 +69,7 @@ class AccountGroupings(BaseSet):
     def wait_for_export(
         self, async_result: AsyncResultItem, max_wait_minutes: int = 5
     ) -> None:
-        """Wait for the async result for the data table export to complete
+        """Wait for the async result for the data table export to complete.
 
         Waits, at most the minutes specified, for the async result to be COMPLETE and
         raises and error if any error
@@ -79,10 +79,11 @@ class AccountGroupings(BaseSet):
             max_wait_minutes (int): Maximum minutes to wait (default: `5`)
 
         Raises:
-            ValueError: If not a ACCOUNT_GROUPING_EXPORT
+            ItemError: If not a ACCOUNT_GROUPING_EXPORT
         """
         if async_result.type != AsyncResultType.ACCOUNT_GROUPING_EXPORT:
-            raise ItemError(f"{async_result.type=}.")
+            msg = f"{async_result.type=}."
+            raise ItemError(msg)
 
         self.async_result_set._wait_for_async_result(
             async_result=async_result,

{mindbridge_api_python_client-1.6.2 → mindbridge_api_python_client-1.8.0}/src/mindbridgeapi/analyses.py

@@ -11,7 +11,6 @@ from datetime import date
 from functools import cached_property
 import logging
 from typing import TYPE_CHECKING, Any, Optional
-import warnings
 from mindbridgeapi.analysis_item import AnalysisItem
 from mindbridgeapi.analysis_results import AnalysisResults
 from mindbridgeapi.analysis_sources import AnalysisSources
@@ -94,22 +93,8 @@ class Analyses(BaseSet):
         return self.get_by_id(analysis_id)
 
     def wait_for_analysis_sources(
-        self,
-        analysis: AnalysisItem,
-        check_interval_seconds: int = -873,  # Depreciated
-        max_wait_minutes: int = 24 * 60,
+        self, analysis: AnalysisItem, max_wait_minutes: int = 24 * 60
     ) -> AnalysisItem:
-        if check_interval_seconds != -873:
-            warnings.warn(
-                "check_interval_seconds was provided to wait_for_analysis_sources as "
-                f"{check_interval_seconds}. This will not be referenced as now the "
-                "check interval will be exponentially increasing to a max interval",
-                category=DeprecationWarning,
-                stacklevel=2,
-            )
-
-        del check_interval_seconds
-
         analysis_id = getattr(analysis, "id", None)
         if analysis_id is None:
             raise ItemNotFoundError
@@ -117,11 +102,13 @@ class Analyses(BaseSet):
         analysis = self.get_by_id(analysis_id)
 
         if getattr(analysis, "id", None) != analysis_id:
-            raise UnexpectedServerError("analysis id was not the same as requested.")
+            msg = "analysis id was not the same as requested."
+            raise UnexpectedServerError(msg)
 
         analysis_sources = list(analysis.analysis_sources)
         if not analysis_sources:
-            raise ItemError("Analysis has no analysis sources to wait for.")
+            msg = "Analysis has no analysis sources to wait for."
+            raise ItemError(msg)
 
         # Get the list of async_result ids
         async_results_to_check = []
@@ -141,10 +128,11 @@ class Analyses(BaseSet):
                 This shouldn't occur as analysis sources are started as soon as they are
                 added to the analysis
                 """
-                raise UnexpectedServerError(
-                    f"Unable to find {EntityType.ANALYSIS_SOURCE} status for:"
-                    f" {analysis_source.id}."
+                msg = (
+                    f"Unable to find {EntityType.ANALYSIS_SOURCE} status for: "
+                    f"{analysis_source.id}."
                 )
+                raise UnexpectedServerError(msg)
 
             async_result = max(
                 async_results_list,
@@ -164,7 +152,7 @@ class Analyses(BaseSet):
             analysis_status, "preflight_errors", []
         )
         if analysis_status_ready:
-            logger.info(f"Analysis ({analysis_id}) is ready to run")
+            logger.info("Analysis (%s) is ready to run", analysis_id)
         else:
             err_msg = f"Analysis ({analysis_id}) is not ready to run"
             if len(analysis_status_preflight_errors) == 0:
@@ -228,32 +216,19 @@ class Analyses(BaseSet):
         logger.info(log_message)
 
     def wait_for_analysis(
-        self,
-        analysis: AnalysisItem,
-        check_interval_seconds: int = -873,  # Depreciated
-        max_wait_minutes: int = 24 * 60,
+        self, analysis: AnalysisItem, max_wait_minutes: int = 24 * 60
     ) -> AnalysisItem:
-        if check_interval_seconds != -873:
-            warnings.warn(
-                "check_interval_seconds was provided to wait_for_analysis as "
-                f"{check_interval_seconds}. This will not be referenced as now the "
-                "check interval will be exponentially increasing to a max interval",
-                category=DeprecationWarning,
-                stacklevel=2,
-            )
-
-        del check_interval_seconds
-
         if analysis.id is None:
             raise ItemNotFoundError
 
         self.restart_analysis_results(analysis)
         analysis_results_list = list(analysis.analysis_results)
         if not analysis_results_list:
-            raise ValidationError(
+            msg = (
                 f"Unable to find any analysis_results for: {analysis.id}. Possibly the "
                 "analysis has not been started yet?"
             )
+            raise ValidationError(msg)
 
         analysis_result = max(
             analysis_results_list, key=lambda x: getattr(x, "creation_date", date.min)
@@ -270,10 +245,11 @@ class Analyses(BaseSet):
         )
         async_results_list = list(async_results)
         if not async_results_list:
-            raise ValidationError(
+            msg = (
                 f"Unable to find {AsyncResultType.ANALYSIS_RUN} for: {analysis.id}."
                 " Possibly the analysis has not been started yet?"
             )
+            raise ValidationError(msg)
 
         async_result = max(
             async_results_list, key=lambda x: getattr(x, "last_modified_date", date.min)