indico_toolkit 7.2.3__tar.gz → 10.1.0__tar.gz

indico_toolkit-10.1.0/PKG-INFO

@@ -0,0 +1,81 @@
+Metadata-Version: 2.4
+Name: indico-toolkit
+Version: 10.1.0
+Summary: Indico Toolkit for Intake and Insights
+License-Expression: MIT
+Requires-Dist: asyncstdlib>=3.14.0,<4.0.0
+Requires-Dist: httpx>=0.28.1,<0.29.0
+Requires-Dist: tenacity>=9.1.4,<10.0.0
+Requires-Python: >=3.11, <4
+Project-URL: source, https://github.com/IndicoDelivery/indico-toolkit-python
+Description-Content-Type: text/markdown
+
+# Indico Toolkit for Intake and Insights
+
+**This repository contains software that is not officially supported by Indico. It may
+  be outdated or contain bugs. The operations it performs are potentially destructive.
+  Use at your own risk.**
+
+Classes, functions, and abstractions for building workflows and workspaces using the Indico platform.
+
+- [MicroClient](https://github.com/IndicoDelivery/indico-toolkit-python/blob/main/src/indico_toolkit/microclient.py)
+  class that provides async methods for making GraphQL, REST, and Storage calls.
+  Includes authentication and best-practices retry. Can be used as a single-file drop-in
+  module with few dependencies for other projects.
+- [ORM](https://github.com/IndicoDelivery/indico-toolkit-python/blob/main/src/indico_toolkit/orm/__init__.py)
+  and [Router](https://github.com/IndicoDelivery/indico-toolkit-python/blob/main/src/indico_toolkit/router/__init__.py)
+  classes for writing Insights custom agents using declarative Data Classes and
+  automatic load and save of instance attributes.
+- [Polling](https://github.com/IndicoDelivery/indico-toolkit-python/blob/main/src/indico_toolkit/polling/__init__.py)
+  classes that implement best-practices polling behavior for Intake Auto Review and
+  Downstream processes. Easily plug in business logic without the boilerplate.
+- [Result File](https://github.com/IndicoDelivery/indico-toolkit-python/blob/main/src/indico_toolkit/results/__init__.py)
+  and [Etl Output](https://github.com/IndicoDelivery/indico-toolkit-python/blob/main/src/indico_toolkit/etloutput/__init__.py)
+  Data Classes that parse standard Intake JSON output into idiomatic, type-safe Python
+  dataclasses.
+
+...and more in the [Examples](https://github.com/IndicoDelivery/indico-toolkit-python/tree/main/examples) folder.
+
+
+## Installation
+
+**Indico Toolkit uses semantic versioning.**
+
+Indico Toolkit versions do not match the Intake or Insights versions they are compatible with.
+See the [Changelog](https://github.com/IndicoDelivery/indico-toolkit-python/blob/main/CHANGELOG.md)
+for the minimum platform version required by each toolkit version.
+
+```bash
+pip install indico-toolkit
+poetry add indico-toolkit
+uv add indico-toolkit
+```
+
+
+## Contributing
+
+Indico Toolkit uses UV for package and dependency management.
+
+
+### Setup
+
+Clone the source repository with Git.
+
+```bash
+git clone git@github.com:IndicoDelivery/indico-toolkit-python.git
+```
+
+Install dependencies with UV.
+
+```bash
+uv sync
+```
+
+Formatting, linting, type checking, and tests are defined as
+[Poe](https://poethepoet.natn.io/) tasks in `pyproject.toml`.
+
+```bash
+uv run poe {format,check,test,all}
+```
+
+Code changes or additions should pass `uv run poe all` before opening a PR.

indico_toolkit-10.1.0/README.md

@@ -0,0 +1,69 @@
+# Indico Toolkit for Intake and Insights
+
+**This repository contains software that is not officially supported by Indico. It may
+  be outdated or contain bugs. The operations it performs are potentially destructive.
+  Use at your own risk.**
+
+Classes, functions, and abstractions for building workflows and workspaces using the Indico platform.
+
+- [MicroClient](https://github.com/IndicoDelivery/indico-toolkit-python/blob/main/src/indico_toolkit/microclient.py)
+  class that provides async methods for making GraphQL, REST, and Storage calls.
+  Includes authentication and best-practices retry. Can be used as a single-file drop-in
+  module with few dependencies for other projects.
+- [ORM](https://github.com/IndicoDelivery/indico-toolkit-python/blob/main/src/indico_toolkit/orm/__init__.py)
+  and [Router](https://github.com/IndicoDelivery/indico-toolkit-python/blob/main/src/indico_toolkit/router/__init__.py)
+  classes for writing Insights custom agents using declarative Data Classes and
+  automatic load and save of instance attributes.
+- [Polling](https://github.com/IndicoDelivery/indico-toolkit-python/blob/main/src/indico_toolkit/polling/__init__.py)
+  classes that implement best-practices polling behavior for Intake Auto Review and
+  Downstream processes. Easily plug in business logic without the boilerplate.
+- [Result File](https://github.com/IndicoDelivery/indico-toolkit-python/blob/main/src/indico_toolkit/results/__init__.py)
+  and [Etl Output](https://github.com/IndicoDelivery/indico-toolkit-python/blob/main/src/indico_toolkit/etloutput/__init__.py)
+  Data Classes that parse standard Intake JSON output into idiomatic, type-safe Python
+  dataclasses.
+
+...and more in the [Examples](https://github.com/IndicoDelivery/indico-toolkit-python/tree/main/examples) folder.
+
+
+## Installation
+
+**Indico Toolkit uses semantic versioning.**
+
+Indico Toolkit versions do not match the Intake or Insights versions they are compatible with.
+See the [Changelog](https://github.com/IndicoDelivery/indico-toolkit-python/blob/main/CHANGELOG.md)
+for the minimum platform version required by each toolkit version.
+
+```bash
+pip install indico-toolkit
+poetry add indico-toolkit
+uv add indico-toolkit
+```
+
+
+## Contributing
+
+Indico Toolkit uses UV for package and dependency management.
+
+
+### Setup
+
+Clone the source repository with Git.
+
+```bash
+git clone git@github.com:IndicoDelivery/indico-toolkit-python.git
+```
+
+Install dependencies with UV.
+
+```bash
+uv sync
+```
+
+Formatting, linting, type checking, and tests are defined as
+[Poe](https://poethepoet.natn.io/) tasks in `pyproject.toml`.
+
+```bash
+uv run poe {format,check,test,all}
+```
+
+Code changes or additions should pass `uv run poe all` before opening a PR.

indico_toolkit-10.1.0/pyproject.toml

@@ -0,0 +1,83 @@
+[build-system]
+requires = ["uv_build>=0.11.0,<1.0.0"]
+build-backend = "uv_build"
+
+[project]
+name = "indico-toolkit"
+description = "Indico Toolkit for Intake and Insights"
+license = "MIT"
+readme = "README.md"
+requires-python = ">=3.11,<4"
+version = "10.1.0"
+dependencies = [
+    "asyncstdlib (>=3.14.0,<4.0.0)",
+    "httpx (>=0.28.1,<0.29.0)",
+    "tenacity (>=9.1.4,<10.0.0)",
+]
+
+[project.urls]
+source = "https://github.com/IndicoDelivery/indico-toolkit-python"
+
+[dependency-groups]
+dev = [
+    "coverage (>=7.0.0)",
+    "poethepoet (>=0.30.0)",
+    "pytest-asyncio (>=1.0.0)",
+    "pytest-cov (>=7.0.0)",
+    "pytest-mock (>=3.0.0)",
+    "pytest (>=9.0.0)",
+    "ruff (>=0.15.0)",
+    "ty (>=0.0.50)",
+]
+
+[tool.poe.tasks]
+coverage = "coverage html"
+pytest = "pytest tests --cov=src --cov=tests"
+ruff-check = "ruff check src tests"
+ruff-fix = "ruff check --fix-only src tests"
+ruff-format = "ruff format src tests"
+ruff-format-check = "ruff format --check src tests"
+ty = "ty check src tests"
+ty-fix = "ty check --fix src tests"
+format = [
+    "ruff-fix",
+    "ruff-format",
+]
+check = [
+    "ruff-check",
+    "ruff-format-check",
+    "ty",
+]
+test = [
+    "pytest",
+    "coverage",
+]
+all = [
+    "format",
+    "check",
+    "test",
+]
+
+[tool.ruff]
+line-length = 88
+
+[tool.ruff.lint]
+select = [
+    "E",
+    "F",
+    "I",
+]
+fixable = ["I"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+
+[tool.coverage.run]
+branch = true
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "@abstractmethod",
+]

indico_toolkit-10.1.0/pyproject.toml.orig

@@ -0,0 +1,59 @@
+[build-system]
+requires = ["uv_build>=0.11.0,<1.0.0"]
+build-backend = "uv_build"
+
+[project]
+name = "indico-toolkit"
+description = "Indico Toolkit for Intake and Insights"
+license = "MIT"
+readme = "README.md"
+urls = { source = "https://github.com/IndicoDelivery/indico-toolkit-python" }
+requires-python = ">=3.11,<4"
+version = "10.1.0"
+dependencies = [
+    "asyncstdlib (>=3.14.0,<4.0.0)",
+    "httpx (>=0.28.1,<0.29.0)",
+    "tenacity (>=9.1.4,<10.0.0)",
+]
+
+[dependency-groups]
+dev = [
+    "coverage (>=7.0.0)",
+    "poethepoet (>=0.30.0)",
+    "pytest-asyncio (>=1.0.0)",
+    "pytest-cov (>=7.0.0)",
+    "pytest-mock (>=3.0.0)",
+    "pytest (>=9.0.0)",
+    "ruff (>=0.15.0)",
+    "ty (>=0.0.50)",
+]
+
+[tool.poe.tasks]
+coverage = "coverage html"
+pytest = "pytest tests --cov=src --cov=tests"
+ruff-check = "ruff check src tests"
+ruff-fix = "ruff check --fix-only src tests"
+ruff-format = "ruff format src tests"
+ruff-format-check = "ruff format --check src tests"
+ty = "ty check src tests"
+ty-fix = "ty check --fix src tests"
+
+format = ["ruff-fix", "ruff-format"]
+check = ["ruff-check", "ruff-format-check", "ty"]
+test = ["pytest", "coverage"]
+all = ["format", "check", "test"]
+
+[tool.ruff]
+line-length = 88
+lint.select = ["E", "F", "I"]
+lint.fixable = ["I"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+
+[tool.coverage.run]
+branch = true
+
+[tool.coverage.report]
+exclude_lines = ["pragma: no cover", "@abstractmethod"]

indico_toolkit-10.1.0/src/indico_toolkit/.mypy_cache/.gitignore

@@ -0,0 +1,2 @@
+# Automatically created by mypy
+*

indico_toolkit-10.1.0/src/indico_toolkit/.mypy_cache/3.11/@plugins_snapshot.json

@@ -0,0 +1 @@
+{}