kanban-core 2.1.0__tar.gz

kanban_core-2.1.0/.gitignore

@@ -0,0 +1,164 @@
+# 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/
+.coverage*
+
+# 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
+
+# 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/#use-with-ide
+.pdm.toml
+
+# 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 added to the global gitignore or merged into this project gitignore.  For a PyCharm
+#  project, it is advised to generate a fresh project using the JetBrains template.
+#   Do not edit any of the settings files in the project root directory.
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be added to the global gitignore or merged into this project gitignore.  For a PyCharm
+#  project, it is advised to generate a fresh project using the JetBrains template.
+.idea/

kanban_core-2.1.0/PKG-INFO

@@ -0,0 +1,177 @@
+Metadata-Version: 2.5
+Name: kanban-core
+Version: 2.1.0
+Summary: A comprehensive, extensible kanban board implementation
+Project-URL: Homepage, https://github.com/adieyal/kanban-core
+Project-URL: Repository, https://github.com/adieyal/kanban-core
+Project-URL: Issues, https://github.com/adieyal/kanban-core/issues
+Author: Adi Eyal
+License: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Provides-Extra: dev
+Requires-Dist: mypy>=1.0; extra == 'dev'
+Requires-Dist: pre-commit>=3.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# kanban-core
+
+[![Tests](https://github.com/adieyal/kanban-core/actions/workflows/test.yml/badge.svg)](https://github.com/adieyal/kanban-core/actions/workflows/test.yml)
+
+A framework-independent Kanban business module for Python 3.10+.
+
+**This is not a Kanban board app.** It's the engine underneath one — boards,
+columns, cards, moves, workflow rules, permissions, automation and events —
+with no UI and no database of its own. You supply persistence, authorization
+and an interface; kanban-core guarantees the board behaves correctly
+underneath them.
+
+Board mechanics — moving cards, enforcing WIP limits, tracking state — get
+rewritten in nearly every Kanban tool because it's hard to find an
+implementation with no UI or database bolted on. kanban-core is that missing
+piece.
+
+Your application talks to one public business API, `KanbanFacade`. The module
+owns its business state and invariants; persistence, authorization, search,
+automation and event delivery are supplied from outside at composition time.
+
+![kanban-core system boundary: applications call KanbanFacade, while infrastructure supplies replaceable contracts](imgs/01-framework-kanban-boundary.png)
+
+## What's included
+
+- Boards, columns and cards, with move validation, WIP limits, card ordering
+  and dependency-cycle checks
+- Configurable workflow policies for deployment-specific rules
+- Permission checks via an injected policy — not hardcoded into the module
+- Search over cards via a pluggable searcher
+- Automation that reacts to events and proposes actions
+- An event system for audit trails, outboxes and integrations
+- Deterministic testing support via injected clock and ID factory
+- Zero dependencies outside the Python standard library
+
+## Installation
+
+```bash
+pip install kanban-core
+```
+
+## Quick example
+
+```python
+from kanban import KanbanFacade
+from kanban_adapters import (
+    EventBus,
+    InMemoryKanbanRepository,
+    SynchronousKanbanUnitOfWork,
+)
+
+repository = InMemoryKanbanRepository()
+events = EventBus()
+
+# Commits the board state and the events produced by the same operation.
+uow = SynchronousKanbanUnitOfWork(repository, events)
+
+kanban = KanbanFacade(repository, uow)
+
+board = kanban.create_board("alice", "Launch")
+todo = board.column_named("To Do")
+in_progress = board.column_named("In Progress")
+assert todo is not None and in_progress is not None
+
+card = kanban.add_card("alice", board.id, todo.id, "Publish release notes")
+kanban.move_card("alice", board.id, card.id, in_progress.id)
+```
+
+`BoardView`, `ColumnView` and `CardView` are immutable observations. Change
+business state only through `KanbanFacade`.
+
+Swap `InMemoryKanbanRepository` for a Postgres- or Django-backed
+implementation and nothing above this line changes — that boundary is the
+whole point of the module. See [Extending Kanban Core](docs/extensibility.md).
+
+### Why both a repository and a unit of work?
+
+They have different responsibilities:
+
+- `KanbanRepository` **reads and stores board snapshots**.
+- `KanbanUnitOfWork` **commits one business operation**, including both the new
+  board snapshot and the events produced by that operation.
+
+The distinction matters most in production. A database-backed unit of work can save
+the board and append its events to an outbox in one transaction, so you do not end
+up with committed state but a lost event.
+
+A useful shorthand is:
+
+> **Repository reads state. Unit of work commits an operation.**
+
+`SynchronousKanbanUnitOfWork` is the reference implementation for tests and simple
+single-process applications. It saves through the repository and then publishes
+through the supplied event publisher.
+
+## Demo UI
+
+The repository includes a small FastAPI example in [`kanban-demo-ui`](kanban-demo-ui/).
+It is an application of the module, not part of the business package. The example
+composes `KanbanFacade` with the in-memory repository, synchronous unit of work and
+event bus, then keeps HTTP routes and browser behavior outside Kanban Core.
+
+Install and run it from the repository root:
+
+```bash
+python -m pip install -e .
+python -m pip install -r kanban-demo-ui/requirements.txt
+python kanban-demo-ui/run_demo.py
+```
+
+The browser uses native HTML drag-and-drop. It updates the card list optimistically,
+then sends the requested move through the facade; the server remains authoritative
+for WIP limits, workflow rules, ordering and event generation. The demo deliberately
+uses in-memory state and has no authentication, CSRF protection or durable outbox.
+
+## Documentation
+
+- **[Quickstart](docs/quickstart.md)** — build and use a board in a few minutes.
+- **[Core concepts](docs/concepts.md)** — the facade boundary, immutable views,
+  ports and composition.
+- **[Extending Kanban Core](docs/extensibility.md)** — persistence, permissions,
+  workflow rules, search, automation and events.
+- **[Integration patterns](docs/integration-patterns.md)** — compose the module in
+  web requests, workers and commands.
+- **[API reference](docs/api-reference.md)** — supported facade, views, exceptions
+  and SPI contracts.
+- **[Architecture](docs/architecture.md)** — why the module is designed this way.
+
+## Public contract
+
+Only names in `kanban.__all__` are supported application API:
+
+- `KanbanFacade` is the only business-operation entry point.
+- `BoardView`, `ColumnView` and `CardView` are immutable return values.
+- public exceptions are exported from `kanban`.
+- infrastructure and extension contracts live under `kanban.spi`.
+
+Internal models and application services are implementation details.
+
+## Development
+
+```bash
+python -m pip install -e ".[dev]"
+make check
+make test
+```
+
+## License
+
+MIT

kanban_core-2.1.0/README.md

@@ -0,0 +1,150 @@
+# kanban-core
+
+[![Tests](https://github.com/adieyal/kanban-core/actions/workflows/test.yml/badge.svg)](https://github.com/adieyal/kanban-core/actions/workflows/test.yml)
+
+A framework-independent Kanban business module for Python 3.10+.
+
+**This is not a Kanban board app.** It's the engine underneath one — boards,
+columns, cards, moves, workflow rules, permissions, automation and events —
+with no UI and no database of its own. You supply persistence, authorization
+and an interface; kanban-core guarantees the board behaves correctly
+underneath them.
+
+Board mechanics — moving cards, enforcing WIP limits, tracking state — get
+rewritten in nearly every Kanban tool because it's hard to find an
+implementation with no UI or database bolted on. kanban-core is that missing
+piece.
+
+Your application talks to one public business API, `KanbanFacade`. The module
+owns its business state and invariants; persistence, authorization, search,
+automation and event delivery are supplied from outside at composition time.
+
+![kanban-core system boundary: applications call KanbanFacade, while infrastructure supplies replaceable contracts](imgs/01-framework-kanban-boundary.png)
+
+## What's included
+
+- Boards, columns and cards, with move validation, WIP limits, card ordering
+  and dependency-cycle checks
+- Configurable workflow policies for deployment-specific rules
+- Permission checks via an injected policy — not hardcoded into the module
+- Search over cards via a pluggable searcher
+- Automation that reacts to events and proposes actions
+- An event system for audit trails, outboxes and integrations
+- Deterministic testing support via injected clock and ID factory
+- Zero dependencies outside the Python standard library
+
+## Installation
+
+```bash
+pip install kanban-core
+```
+
+## Quick example
+
+```python
+from kanban import KanbanFacade
+from kanban_adapters import (
+    EventBus,
+    InMemoryKanbanRepository,
+    SynchronousKanbanUnitOfWork,
+)
+
+repository = InMemoryKanbanRepository()
+events = EventBus()
+
+# Commits the board state and the events produced by the same operation.
+uow = SynchronousKanbanUnitOfWork(repository, events)
+
+kanban = KanbanFacade(repository, uow)
+
+board = kanban.create_board("alice", "Launch")
+todo = board.column_named("To Do")
+in_progress = board.column_named("In Progress")
+assert todo is not None and in_progress is not None
+
+card = kanban.add_card("alice", board.id, todo.id, "Publish release notes")
+kanban.move_card("alice", board.id, card.id, in_progress.id)
+```
+
+`BoardView`, `ColumnView` and `CardView` are immutable observations. Change
+business state only through `KanbanFacade`.
+
+Swap `InMemoryKanbanRepository` for a Postgres- or Django-backed
+implementation and nothing above this line changes — that boundary is the
+whole point of the module. See [Extending Kanban Core](docs/extensibility.md).
+
+### Why both a repository and a unit of work?
+
+They have different responsibilities:
+
+- `KanbanRepository` **reads and stores board snapshots**.
+- `KanbanUnitOfWork` **commits one business operation**, including both the new
+  board snapshot and the events produced by that operation.
+
+The distinction matters most in production. A database-backed unit of work can save
+the board and append its events to an outbox in one transaction, so you do not end
+up with committed state but a lost event.
+
+A useful shorthand is:
+
+> **Repository reads state. Unit of work commits an operation.**
+
+`SynchronousKanbanUnitOfWork` is the reference implementation for tests and simple
+single-process applications. It saves through the repository and then publishes
+through the supplied event publisher.
+
+## Demo UI
+
+The repository includes a small FastAPI example in [`kanban-demo-ui`](kanban-demo-ui/).
+It is an application of the module, not part of the business package. The example
+composes `KanbanFacade` with the in-memory repository, synchronous unit of work and
+event bus, then keeps HTTP routes and browser behavior outside Kanban Core.
+
+Install and run it from the repository root:
+
+```bash
+python -m pip install -e .
+python -m pip install -r kanban-demo-ui/requirements.txt
+python kanban-demo-ui/run_demo.py
+```
+
+The browser uses native HTML drag-and-drop. It updates the card list optimistically,
+then sends the requested move through the facade; the server remains authoritative
+for WIP limits, workflow rules, ordering and event generation. The demo deliberately
+uses in-memory state and has no authentication, CSRF protection or durable outbox.
+
+## Documentation
+
+- **[Quickstart](docs/quickstart.md)** — build and use a board in a few minutes.
+- **[Core concepts](docs/concepts.md)** — the facade boundary, immutable views,
+  ports and composition.
+- **[Extending Kanban Core](docs/extensibility.md)** — persistence, permissions,
+  workflow rules, search, automation and events.
+- **[Integration patterns](docs/integration-patterns.md)** — compose the module in
+  web requests, workers and commands.
+- **[API reference](docs/api-reference.md)** — supported facade, views, exceptions
+  and SPI contracts.
+- **[Architecture](docs/architecture.md)** — why the module is designed this way.
+
+## Public contract
+
+Only names in `kanban.__all__` are supported application API:
+
+- `KanbanFacade` is the only business-operation entry point.
+- `BoardView`, `ColumnView` and `CardView` are immutable return values.
+- public exceptions are exported from `kanban`.
+- infrastructure and extension contracts live under `kanban.spi`.
+
+Internal models and application services are implementation details.
+
+## Development
+
+```bash
+python -m pip install -e ".[dev]"
+make check
+make test
+```
+
+## License
+
+MIT

kanban_core-2.1.0/pyproject.toml

@@ -0,0 +1,171 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "kanban-core"
+version = "2.1.0"
+description = "A comprehensive, extensible kanban board implementation"
+readme = "README.md"
+license = {text = "MIT"}
+authors = [{ name = "Adi Eyal" }]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+requires-python = ">=3.10"
+dependencies = []
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-cov>=4.0",
+    "ruff>=0.1.0",
+    "pre-commit>=3.0",
+    "mypy>=1.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/adieyal/kanban-core"
+Repository = "https://github.com/adieyal/kanban-core"
+Issues = "https://github.com/adieyal/kanban-core/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/kanban", "src/kanban_adapters"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/src",
+    "/tests",
+    "/README.md",
+    "/LICENSE",
+]
+
+# Ruff configuration
+[tool.ruff]
+target-version = "py310"
+line-length = 88
+src = ["src", "tests"]
+
+[tool.ruff.lint]
+select = [
+    "E",   # pycodestyle errors
+    "W",   # pycodestyle warnings
+    "F",   # pyflakes
+    "I",   # isort
+    "B",   # flake8-bugbear
+    "C4",  # flake8-comprehensions
+    "UP",  # pyupgrade
+    "ARG", # flake8-unused-arguments
+    "SIM", # flake8-simplify
+]
+ignore = [
+    "E501",  # line too long (handled by formatter)
+    "B008",  # do not perform function calls in argument defaults
+    "B904",  # raise ... from None
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**/*" = ["ARG", "S101"]  # Allow unused args and assert statements in tests
+
+[tool.ruff.lint.isort]
+known-first-party = ["kanban", "kanban_adapters"]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+
+# Pytest configuration
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py", "*_test.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]
+addopts = [
+    "--strict-markers",
+    "--strict-config",
+    "--verbose",
+]
+filterwarnings = [
+    "error",
+    "ignore::UserWarning",
+]
+
+[tool.importlinter]
+root_packages = ["kanban", "kanban_adapters"]
+
+[[tool.importlinter.contracts]]
+name = "Adapters use only the kanban SPI"
+type = "forbidden"
+source_modules = ["kanban_adapters"]
+forbidden_modules = [
+    "kanban",
+]
+ignore_imports = [
+    "kanban_adapters.events -> kanban.spi",
+    "kanban_adapters.repositories -> kanban.spi",
+    "kanban_adapters.synchronous -> kanban.spi",
+]
+
+# Coverage configuration
+[tool.coverage.run]
+source = ["src"]
+branch = true
+omit = [
+    "*/tests/*",
+    "*/test_*",
+    "*/__init__.py",
+]
+
+[tool.coverage.report]
+show_missing = true
+skip_covered = false
+skip_empty = true
+precision = 2
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "if self.debug:",
+    "if settings.DEBUG",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if 0:",
+    "if __name__ == .__main__.:",
+    "class .*\\bProtocol\\):",
+    "@(abc\\.)?abstractmethod",
+    "\\.\\.\\.",  # Ellipsis
+    "pass",
+]
+
+[tool.coverage.html]
+directory = "htmlcov"
+
+[tool.coverage.xml]
+output = "coverage.xml"
+
+# MyPy configuration
+[tool.mypy]
+python_version = "3.10"
+check_untyped_defs = true
+disallow_any_generics = true
+disallow_incomplete_defs = true
+disallow_untyped_defs = true
+no_implicit_optional = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_return_any = true
+strict_equality = true
+
+[dependency-groups]
+dev = [
+    "import-linter>=2.13",
+]

kanban_core-2.1.0/src/kanban/__init__.py

@@ -0,0 +1,26 @@
+"""Public API for the kanban business module."""
+
+from .exceptions import (
+    ConcurrencyError,
+    InvalidPersistenceStateError,
+    KanbanError,
+    NotFoundError,
+    PermissionError,
+    ValidationError,
+)
+from .facade import BoardView, CardView, ColumnView, KanbanFacade
+
+__version__ = "2.1.0"
+
+__all__ = [
+    "BoardView",
+    "CardView",
+    "ColumnView",
+    "ConcurrencyError",
+    "InvalidPersistenceStateError",
+    "KanbanError",
+    "KanbanFacade",
+    "NotFoundError",
+    "PermissionError",
+    "ValidationError",
+]