mindbridge-api-python-client 1.4.8__tar.gz

mindbridge_api_python_client-1.4.8/LICENSE.txt

@@ -0,0 +1,11 @@
+This package contains intellectual property proprietary to MindBridge as per
+the Agreement, in addition to sample data sets, and shall be used for internal
+purposes by MindBridge clients only.
+
+You may include portions of this package in your software as needed for the
+purposes of consuming the MindBridge API.
+
+You may not redistribute this package to third parties except for the express
+purposes of the third party needing to develop software to integrate with
+MindBridge in order to further utilization of the MindBridge Software per the
+applicable Agreement.

mindbridge_api_python_client-1.4.8/PKG-INFO

@@ -0,0 +1,64 @@
+Metadata-Version: 2.1
+Name: mindbridge-api-python-client
+Version: 1.4.8
+Summary: Interact with the MindBridge API
+Home-page: https://www.mindbridge.ai
+License: Proprietary
+Author: Edgar Silva
+Author-email: edgar.silva@mindbridge.ai
+Maintainer: Kevin Paulson
+Maintainer-email: kevin.paulson@mindbridge.ai
+Requires-Python: >=3.8.1,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Flake8
+Classifier: Framework :: Pydantic
+Classifier: Framework :: Pydantic :: 2
+Classifier: Framework :: Pytest
+Classifier: License :: Other/Proprietary License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+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 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Typing :: Typed
+Requires-Dist: pydantic (>=2.5.2,<3.0.0)
+Requires-Dist: typing-extensions (>=4.0.0,<5.0.0) ; python_version < "3.9"
+Requires-Dist: urllib3 (>=2.0.7,<3.0.0)
+Project-URL: Repository, https://github.com/mindbridge-ai/mindbridge-api-python-client
+Description-Content-Type: text/markdown
+
+<h1 align="center">MindBridge API Python Client</h1>
+<p align="center">
+    <img alt="Logo of MindBridge" src="https://www.mindbridge.ai/wp-content/uploads/2021/07/MindBridge_Logo_Primary_RGB.png" />
+</p>
+
+Interact with the MindBridge API using this Python SDK. Please see [The MindBridge API](https://www.mindbridge.ai/support/api/) for more information about the MindBridge API. You can also [Access MindBridge Customer Support](https://support.mindbridge.ai/hc/en-us/articles/360054147834-Access-MindBridge-Customer-Support) or [Contact us](https://www.mindbridge.ai/contact/).
+
+## Installation
+mindbridge-api-python-client can be installed with [pip](https://pip.pypa.io):
+
+```sh
+python -m pip install mindbridge-api-python-client
+```
+
+## Usage
+Replace `subdomain.mindbridge.ai` with your MindBridge tenant URL.
+```python
+import getpass
+import mindbridgeapi as mbapi
+
+url = "subdomain.mindbridge.ai"
+token = getpass.getpass(f"Token for {url}: ")
+
+server = mbapi.Server(url=url, token=token)
+
+organization = mbapi.OrganizationItem(name="My Organization name")
+organization = server.organizations.create(organization)
+
+# Create engagements, analyses and run them, etc.
+```
+

mindbridge_api_python_client-1.4.8/README.md

@@ -0,0 +1,30 @@
+<h1 align="center">MindBridge API Python Client</h1>
+<p align="center">
+    <img alt="Logo of MindBridge" src="https://www.mindbridge.ai/wp-content/uploads/2021/07/MindBridge_Logo_Primary_RGB.png" />
+</p>
+
+Interact with the MindBridge API using this Python SDK. Please see [The MindBridge API](https://www.mindbridge.ai/support/api/) for more information about the MindBridge API. You can also [Access MindBridge Customer Support](https://support.mindbridge.ai/hc/en-us/articles/360054147834-Access-MindBridge-Customer-Support) or [Contact us](https://www.mindbridge.ai/contact/).
+
+## Installation
+mindbridge-api-python-client can be installed with [pip](https://pip.pypa.io):
+
+```sh
+python -m pip install mindbridge-api-python-client
+```
+
+## Usage
+Replace `subdomain.mindbridge.ai` with your MindBridge tenant URL.
+```python
+import getpass
+import mindbridgeapi as mbapi
+
+url = "subdomain.mindbridge.ai"
+token = getpass.getpass(f"Token for {url}: ")
+
+server = mbapi.Server(url=url, token=token)
+
+organization = mbapi.OrganizationItem(name="My Organization name")
+organization = server.organizations.create(organization)
+
+# Create engagements, analyses and run them, etc.
+```

mindbridge_api_python_client-1.4.8/pyproject.toml

@@ -0,0 +1,130 @@
+[build-system]
+requires = [ "poetry-core" ]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry]
+name = "mindbridge-api-python-client"
+version = "1.4.8"
+description = "Interact with the MindBridge API"
+license = "Proprietary"
+authors = [
+    "Edgar Silva <edgar.silva@mindbridge.ai>",
+    "Jordan Hatcher <jordan.hatcher@mindbridge.ai>",
+    "Kevin Paulson <kevin.paulson@mindbridge.ai",
+    "Michael Smith <msmith@mindbridge.ai>",
+    "Wing-Leung Chan <wing-leung.chan@mindbridge.ai>",
+]
+maintainers = [ "Kevin Paulson <kevin.paulson@mindbridge.ai>" ]
+readme = "README.md"
+homepage = "https://www.mindbridge.ai"
+repository = "https://github.com/mindbridge-ai/mindbridge-api-python-client"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Framework :: Flake8",
+    "Framework :: Pydantic",
+    "Framework :: Pydantic :: 2",
+    "Framework :: Pytest",
+    "License :: Other/Proprietary License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Typing :: Typed",
+]
+packages = [
+    { include = "mindbridgeapi", from = "src" },
+]
+
+[tool.poetry.dependencies]
+python = ">=3.8.1,<4.0"
+pydantic = "^2.5.2"
+typing-extensions = { version = "^4.0.0", python = "<3.9" }
+urllib3 = "^2.0.7"
+
+[tool.poetry.group.generate_model]
+optional = true
+
+[tool.poetry.group.generate_model.dependencies]
+datamodel-code-generator = "^0.25.1"
+
+[tool.poetry.group.lint]
+optional = true
+
+[tool.poetry.group.lint.dependencies]
+black = "^24.3.0"
+flake8 = "^7.0.0"
+flake8-bugbear = "^24.2.6"
+flake8-clean-block = "^0.1.2"
+flake8-comprehensions = "^3.14.0"
+flake8-encodings = "^0.5.1"
+flake8-implicit-str-concat = "^0.4.0"
+flake8-newspaper-style = "^0.4.3"
+flake8-pytest-style = "^2.0.0"
+flake8-return = "^1.2.0"
+flake8-simplify = "^0.21.0"
+flake8-tidy-imports = "^4.10.0"
+flake8-type-checking = "^2.9.0"
+isort = "^5.13.2"
+pep8-naming = "^0.14.1"
+tryceratops = "^2.3.2"
+
+[tool.poetry.group.test]
+optional = true
+
+[tool.poetry.group.test.dependencies]
+pytest = "^8.1.1"
+pytest-cov = "^5.0.0"
+pytest-randomly = "^3.15.0"
+
+[tool.poetry.group.type_check]
+optional = true
+
+[tool.poetry.group.type_check.dependencies]
+mypy = "^1.9.0"
+
+[tool.black]
+target-version = [ "py38", "py39", "py310", "py311", "py312" ]
+
+[tool.isort]
+py_version = 38
+profile = "black"
+lines_between_sections = 0
+force_sort_within_sections = true
+known_first_party = [ "mindbridgeapi" ]
+
+[tool.pytest.ini_options]
+addopts = [
+    "--strict-config",
+    "--strict-markers",
+    "--cov=mindbridgeapi",
+    "--cov-report=html",
+    "--cov-report=term",
+    "--cov-report=xml",
+]
+xfail_strict = true
+filterwarnings = [ "error" ]
+
+[tool.coverage.run]
+branch = true
+omit = [ "src/mindbridgeapi/generated_pydantic_model/*" ]
+
+[tool.coverage.report]
+exclude_also = [ "if TYPE_CHECKING:" ]
+
+[tool.mypy]
+mypy_path = "$MYPY_CONFIG_FILE_DIR/src"
+packages = "mindbridgeapi,tools.generate_model"
+plugins = [ "pydantic.mypy" ]
+strict = true
+no_implicit_optional = true
+show_error_codes = true
+
+[tool.pydantic-mypy]
+init_forbid_extra = true
+init_typed = true
+warn_required_dynamic_aliases = true

mindbridge_api_python_client-1.4.8/src/mindbridgeapi/__init__.py

@@ -0,0 +1,69 @@
+#
+#  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.
+#
+
+from mindbridgeapi.accounting_period import AccountingPeriod
+from mindbridgeapi.analysis_item import AnalysisItem
+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.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
+from mindbridgeapi.generated_pydantic_model.model import (
+    PeriodType as AnalysisEffectiveDateMetricsPeriod,
+)
+from mindbridgeapi.generated_pydantic_model.model import Frequency
+from mindbridgeapi.generated_pydantic_model.model import Status4 as TaskStatus
+from mindbridgeapi.generated_pydantic_model.model import TargetWorkflowState
+from mindbridgeapi.generated_pydantic_model.model import Type5 as FileManagerType
+from mindbridgeapi.generated_pydantic_model.model import Type11 as TaskType
+from mindbridgeapi.generated_pydantic_model.model import Type13 as TransactionIdType
+from mindbridgeapi.generated_pydantic_model.model import Type17 as VirtualColumnType
+from mindbridgeapi.library_item import LibraryItem
+from mindbridgeapi.organization_item import OrganizationItem
+from mindbridgeapi.server import Server
+from mindbridgeapi.task_item import TaskItem
+from mindbridgeapi.transaction_id_selection import TransactionIdSelection
+from mindbridgeapi.virtual_column import VirtualColumn
+
+__all__ = [
+    "AccountingPeriod",
+    "AnalysisItem",
+    "AnalysisPeriod",
+    "AnalysisSourceItem",
+    "AnalysisSourceTypeItem",
+    "AnalysisTypeItem",
+    "ChunkedFileItem",
+    "ChunkedFilePartItem",
+    "ColumnMapping",
+    "EngagementItem",
+    "AnalysisSourceType",
+    "AnalysisType",
+    "SystemLibrary",
+    "FileManagerItem",
+    "AnalysisEffectiveDateMetricsPeriod",
+    "Frequency",
+    "TaskStatus",
+    "TargetWorkflowState",
+    "FileManagerType",
+    "TaskType",
+    "TransactionIdType",
+    "VirtualColumnType",
+    "LibraryItem",
+    "OrganizationItem",
+    "Server",
+    "TaskItem",
+    "TransactionIdSelection",
+    "VirtualColumn",
+]

mindbridge_api_python_client-1.4.8/src/mindbridgeapi/accounting_period.py

@@ -0,0 +1,34 @@
+#
+#  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.
+#
+
+from pydantic import ConfigDict, Field, model_validator
+from mindbridgeapi.common_validators import _warning_if_extra_fields
+from mindbridgeapi.generated_pydantic_model.model import (
+    ApiAccountingPeriodRead,
+    Frequency,
+)
+
+
+class AccountingPeriod(ApiAccountingPeriodRead):
+    fiscal_start_month: int = Field().merge_field_infos(
+        ApiAccountingPeriodRead.model_fields["fiscal_start_month"], default=1
+    )
+    fiscal_start_day: int = Field().merge_field_infos(
+        ApiAccountingPeriodRead.model_fields["fiscal_start_day"], default=1
+    )
+    frequency: Frequency = Field().merge_field_infos(
+        ApiAccountingPeriodRead.model_fields["frequency"], default=Frequency.ANNUAL
+    )
+
+    model_config = ConfigDict(
+        extra="allow",
+        validate_assignment=True,
+        validate_default=True,
+        validate_return=True,
+    )
+    _ = model_validator(mode="after")(_warning_if_extra_fields)