haiway 0.10.1__tar.gz → 0.10.11__tar.gz

haiway-0.10.11/.github/workflows/ci.yml

@@ -0,0 +1,35 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+    branches:
+      - "*"
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install
+        run: uv sync --all-groups --all-extras --frozen --no-python-downloads
+
+      - name: Lint
+        run: uv run ruff check --output-format=github ./src ./tests
+
+      - name: Test
+        run: uv run pytest --rootdir= ./tests --doctest-modules --junitxml=junit/test-results.xml

haiway-0.10.11/.github/workflows/publish.yml

@@ -0,0 +1,35 @@
+name: publish
+
+on:
+  release:
+    types:
+      - released
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.release.tag_name }}
+
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: 3.12
+
+      - name: Install
+        run: uv sync --all-groups --all-extras --frozen --no-python-downloads
+
+      - name: Lint
+        run: uv run ruff check --output-format=github ./src ./tests
+
+      - name: Test
+        run: uv run pytest --rootdir= ./tests --doctest-modules --junitxml=junit/test-results.xml
+
+      - name: Publish
+        env:
+          PROJECT_VERSION: ${{ github.event.release.tag_name }}
+        run: uv build && uv publish

haiway-0.10.11/.gitignore

@@ -0,0 +1,83 @@
+## macOS
+.DS_Store
+.AppleDouble
+.LSOverride
+._*
+.fseventsd
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+## Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+*.manifest
+*.spec
+pip-log.txt
+pip-delete-this-directory.txt
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+*.mo
+*.pot
+.ipynb_checkpoints
+.python-version
+.env
+.venv
+.dev_venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+.ropeproject
+/site
+.mypy_cache/
+.dmypy.json
+dmypy.json
+.venv/
+[Bb]in
+[Ii]nclude
+[Ll]ib
+[Ll]ib64
+[Ll]ocal
+[Ss]cripts
+pyvenv.cfg
+pip-selfcheck.json
+
+## Editors
+.vscode/
+.idea/
+local_cache/

haiway-0.10.11/Makefile

@@ -0,0 +1,89 @@
+SHELL := sh
+.ONESHELL:
+.SHELLFLAGS := -eu -c
+.DELETE_ON_ERROR:
+
+SOURCES_PATH := src
+TESTS_PATH := tests
+
+# load environment config from .env if able
+-include .env
+
+ifndef UV_VERSION
+	UV_VERSION := 0.6.2
+endif
+
+.PHONY: uv_check venv sync update format lint test release
+
+# Check installed UV version and install if needed
+uv_check:
+	@echo 'Checking uv version...'
+
+	# Install if not present
+	@if ! command -v uv > /dev/null; then \
+		echo '...installing uv...'; \
+		curl -LsSf https://github.com/astral-sh/uv/releases/download/$(UV_VERSION)/uv-installer.sh | sh; \
+		if [ $$? -ne 0 ]; then \
+			echo "...installing uv failed!"; \
+			exit 1; \
+		fi; \
+	fi
+
+	# Check version and update if needed
+	@if command -v uv > /dev/null; then \
+		CURRENT_VERSION=$$(uv --version | head -n1 | cut -d" " -f2); \
+		if [ "$$(printf "%s\n%s" "$(UV_VERSION)" "$$CURRENT_VERSION" | sort -V | head -n1)" != "$(UV_VERSION)" ]; then \
+			echo '...updating uv...'; \
+			curl -LsSf https://github.com/astral-sh/uv/releases/download/$(UV_VERSION)/uv-installer.sh | sh; \
+			if [ $$? -ne 0 ]; then \
+				echo "...updating uv failed!"; \
+				exit 1; \
+			fi; \
+		else \
+			echo '...uv version is up-to-date!'; \
+		fi; \
+	fi
+
+# Setup virtual environment for local development.
+venv: uv_check
+	@echo '# Preparing development environment...'
+	@echo '...cloning .env...'
+	@cp -n ./config/.env.example ./.env || :
+	@echo '...preparing git hooks...'
+	@cp -n ./config/pre-push ./.git/hooks/pre-push || :
+	@echo '...preparing venv...'
+	@uv sync --all-groups --all-extras --frozen --reinstall
+	@echo '...development environment ready! Activate venv using `. ./.venv/bin/activate`.'
+
+# Sync environment with uv based on constraints
+sync: uv_check
+	@echo '# Synchronizing dependencies...'
+	@uv sync --all-groups --all-extras --frozen
+	@echo '...finished!'
+
+# Update and lock dependencies from pyproject.toml
+update:
+	@echo '# Updating dependencies...'
+	@uv sync --all-groups --all-extras --upgrade
+	@echo '...finished!'
+
+# Run formatter.
+format:
+	@ruff check --quiet --fix $(SOURCES_PATH) $(TESTS_PATH)
+	@ruff format --quiet $(SOURCES_PATH) $(TESTS_PATH)
+
+# Run linters and code checks.
+lint:
+	@bandit -r $(SOURCES_PATH)
+	@ruff check $(SOURCES_PATH) $(TESTS_PATH)
+	@pyright --project ./
+
+# Run tests suite.
+test:
+	@python -B -m pytest -v --cov=$(SOURCES_PATH) --rootdir=$(TESTS_PATH)
+
+release: lint test
+	@echo '# Preparing release...'
+	@uv build
+	@uv publish
+	@echo '...finished!'

{haiway-0.10.1/src/haiway.egg-info → haiway-0.10.11}/PKG-INFO

@@ -1,7 +1,9 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: haiway
-Version: 0.10.1
+Version: 0.10.11
 Summary: Framework for dependency injection and state management within structured concurrency model.
+Project-URL: Homepage, https://miquido.com
+Project-URL: Repository, https://github.com/miquido/haiway.git
 Maintainer-email: Kacper Kaliński <kacper.kalinski@miquido.com>
 License: MIT License
         
@@ -24,25 +26,22 @@ License: MIT License
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
-Project-URL: Homepage, https://miquido.com
-Project-URL: Repository, https://github.com/miquido/haiway.git
-Classifier: License :: OSI Approved :: MIT License
+License-File: LICENSE
 Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python
-Classifier: Typing :: Typed
 Classifier: Topic :: Software Development
 Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Typing :: Typed
 Requires-Python: >=3.12
-Description-Content-Type: text/markdown
-License-File: LICENSE
 Provides-Extra: dev
-Requires-Dist: haiway; extra == "dev"
-Requires-Dist: ruff~=0.9; extra == "dev"
-Requires-Dist: pyright~=1.1; extra == "dev"
-Requires-Dist: bandit~=1.7; extra == "dev"
-Requires-Dist: pytest~=7.4; extra == "dev"
-Requires-Dist: pytest-cov~=4.1; extra == "dev"
-Requires-Dist: pytest-asyncio~=0.23; extra == "dev"
+Requires-Dist: bandit~=1.7; extra == 'dev'
+Requires-Dist: pyright~=1.1; extra == 'dev'
+Requires-Dist: pytest-asyncio~=0.23; extra == 'dev'
+Requires-Dist: pytest-cov~=4.1; extra == 'dev'
+Requires-Dist: pytest~=7.4; extra == 'dev'
+Requires-Dist: ruff~=0.9; extra == 'dev'
+Description-Content-Type: text/markdown
 
 # 🚗 haiway 🚕 🚚 🚙
 

haiway-0.10.11/config/pre-push

@@ -0,0 +1,57 @@
+#!/bin/sh
+
+if git rev-parse --verify HEAD >/dev/null 2>&1
+then
+	against=HEAD
+else
+	against=$(git hash-object -t tree /dev/null)
+fi
+
+remote="$1"
+url="$2"
+
+zero=$(git hash-object --stdin </dev/null | tr '[0-9a-f]' '0')
+
+while read local_ref local_oid remote_ref remote_oid
+do
+	if test "$local_oid" = "$zero"
+	then
+		# Handle delete
+		:
+	else
+		if test "$remote_oid" = "$zero"
+		then
+			# New branch, examine all commits
+			range="$local_oid"
+		else
+			# Update to existing branch, examine new commits
+			range="$remote_oid..$local_oid"
+		fi
+
+		# Check for WIP commit
+		commit=$(git rev-list -n 1 --grep '^WIP' "$range")
+		if test -n "$commit"
+		then
+			echo >&2 "Found WIP commit in $local_ref, not pushing"
+			exit 1
+		fi
+	fi
+done
+
+. ./.venv/bin/activate
+
+make lint
+
+if test $? != 0
+then
+	cat <<\EOF
+
+Error: Linting failed.
+
+Ensure project quality and make all linting rules pass!
+
+EOF
+	exit 1
+fi
+
+exec git diff-index --check --cached $against --

haiway-0.10.11/examples/fastAPI/.dockerignore

@@ -0,0 +1,5 @@
+*
+!./pyproject.toml
+!./config/unit.json
+!./src
+!./uv.lock

haiway-0.10.11/examples/fastAPI/Dockerfile

@@ -0,0 +1,37 @@
+ARG PYTHON_TAG=3.12
+ARG UNIT_TAG=1.32.1-python${PYTHON_TAG}
+
+# SERVER #
+
+FROM unit:${UNIT_TAG} AS server_builder
+
+# copy only the parts needed for production
+COPY ./src/integrations ./src/integrations
+COPY ./src/solutions ./src/solutions
+COPY ./src/features ./src/features
+COPY ./src/server ./src/server
+
+# install dependencies and packages
+COPY --from=ghcr.io/astral-sh/uv:0.5.14 /uv /uvx /bin/
+
+ENV UV_PROJECT_ENVIRONMENT="/usr/local/"
+
+RUN --mount=type=bind,source=./uv.lock,target=./uv.lock --mount=type=bind,source=./pyproject.toml,target=./pyproject.toml uv sync --python python${PYTHON_TAG} --locked --no-editable --no-python-downloads --link-mode copy --compile-bytecode --only-group server
+
+FROM server_builder AS server
+
+# allow access to home directory for asyncpg library
+RUN chgrp -R unit ${HOME} && chmod -R 050 ${HOME}
+
+RUN apt-get update \
+  && apt-get upgrade -y \
+  && apt-get -y autoremove \
+  && apt-get clean \
+  && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+
+# copy configuration
+COPY ./config/unit.json /docker-entrypoint.d/config.json
+
+CMD ["unitd", "--no-daemon", "--log", "/dev/stdout"]
+
+# port 80 is already exposed by nginx unit image, can't change it...

haiway-0.10.11/examples/fastAPI/Makefile

@@ -0,0 +1,86 @@
+SHELL := sh
+.ONESHELL:
+.SHELLFLAGS := -eu -c
+.DELETE_ON_ERROR:
+
+SOURCES_PATH := src
+
+# load environment config from .env if able
+-include .env
+
+ifndef UV_VERSION
+	UV_VERSION := 0.5.14
+endif
+
+.PHONY: uv_check venv sync update format lint run docker_run
+
+# Check installed UV version and install if needed
+uv_check:
+	@echo 'Checking uv version...'
+
+	# Install if not present
+	@if ! command -v uv > /dev/null; then \
+		echo '...installing uv...'; \
+		curl -LsSf https://github.com/astral-sh/uv/releases/download/$(UV_VERSION)/uv-installer.sh | sh; \
+		if [ $$? -ne 0 ]; then \
+			echo "...installing uv failed!"; \
+			exit 1; \
+		fi; \
+	fi
+
+	# Check version and update if needed
+	@if command -v uv > /dev/null; then \
+		CURRENT_VERSION=$$(uv --version | head -n1 | cut -d" " -f2); \
+		if [ "$$(printf "%s\n%s" "$(UV_VERSION)" "$$CURRENT_VERSION" | sort -V | head -n1)" != "$(UV_VERSION)" ]; then \
+			echo '...updating uv...'; \
+			curl -LsSf https://github.com/astral-sh/uv/releases/download/$(UV_VERSION)/uv-installer.sh | sh; \
+			if [ $$? -ne 0 ]; then \
+				echo "...updating uv failed!"; \
+				exit 1; \
+			fi; \
+		else \
+			echo '...uv version is up-to-date!'; \
+		fi; \
+	fi
+
+# Setup virtual environment for local development.
+venv: uv_check
+	@echo '# Preparing development environment...'
+	@echo '...cloning .env...'
+	@cp -n ./config/.env.example ./.env || :
+	@echo '...preparing git hooks...'
+	@cp -n ./config/pre-push ./.git/hooks/pre-push || :
+	@echo '...preparing venv...'
+	@uv sync --all-groups --all-extras --frozen --reinstall
+	@echo '...development environment ready! Activate venv using `. ./.venv/bin/activate`.'
+
+# Sync environment with uv based on constraints
+sync: uv_check
+	@echo '# Synchronizing dependencies...'
+	@uv sync --all-groups --all-extras --frozen
+	@echo '...finished!'
+
+# Update and lock dependencies from pyproject.toml
+update:
+	@echo '# Updating dependencies...'
+	@uv sync --all-groups --all-extras --upgrade
+	@echo '...finished!'
+
+# Run formatter.
+format:
+	@ruff check --quiet --fix $(SOURCES_PATH)
+	@ruff format --quiet $(SOURCES_PATH)
+
+# Run linters and code checks.
+lint:
+	@bandit -r $(SOURCES_PATH)
+	@ruff check $(SOURCES_PATH)
+	@pyright --project ./
+
+# Run the server
+run:
+	@python -m server
+
+	# Run all services locally using docker-compose.
+docker_run:
+	@docker compose up --force-recreate --build server

haiway-0.10.11/examples/fastAPI/README.md

@@ -0,0 +1 @@
+## Haiway FastAPI Example

haiway-0.10.11/examples/fastAPI/config/.env.example

@@ -0,0 +1,11 @@
+PYTHONOPTIMIZE=0
+DEBUG_LOGGING=1
+# Server
+SERVER_PORT=8080
+# Postgres
+POSTGRES_DATABASE=postgres
+POSTGRES_HOST=localhost
+POSTGRES_PORT=5432
+POSTGRES_USER=postgres
+POSTGRES_PASSWORD=postgres
+POSTGRES_SSLMODE=disable

haiway-0.10.11/examples/fastAPI/config/unit.json

@@ -0,0 +1,50 @@
+{
+  "listeners": {
+    "*:80": {
+      "pass": "routes/api"
+    }
+  },
+  "routes": {
+    "api": [
+      {
+        "match": {
+          "uri": "/health"
+        },
+        "action": {
+          "return": 204
+        }
+      },
+      {
+        "match": {
+          "uri": "/*"
+        },
+        "action": {
+          "pass": "applications/server"
+        }
+      }
+    ]
+  },
+  "applications": {
+    "server": {
+      "type": "python",
+      "protocol": "asgi",
+      "path": "/",
+      "module": "server",
+      "callable": "app",
+      "processes": 1,
+      "environment": {
+        "PYTHONOPTIMIZE": "2",
+        "HOME": "."
+      }
+    }
+  },
+  "access_log": {
+    "path": "/dev/stdout",
+    "format": "$time_local [ACCESS] $request_line -> $status"
+  },
+  "settings": {
+    "http": {
+      "server_version": false
+    }
+  }
+}

haiway-0.10.11/examples/fastAPI/docker-compose.yml

@@ -0,0 +1,44 @@
+services:
+  server:
+    depends_on:
+      postgres:
+        condition: service_healthy
+    links:
+      - postgres
+    build:
+      context: .
+      dockerfile: Dockerfile
+      target: server
+    ports:
+      - ${SERVER_PORT:-8080}:80
+    restart: no
+    environment:
+      PYTHONOPTIMIZE: ${PYTHONOPTIMIZE:-2}
+      DEBUG_LOGGING: ${DEBUG_LOGGING}
+      POSTGRES_DATABASE: ${POSTGRES_DATABASE}
+      POSTGRES_HOST: postgres
+      POSTGRES_PORT: 5432
+      POSTGRES_USER: ${POSTGRES_USER}
+      POSTGRES_SSLMODE: ${POSTGRES_SSLMODE:-prefer}
+      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
+
+  postgres:
+    image: postgres:16.3-alpine3.20
+    restart: always
+    environment:
+      POSTGRES_USER: ${POSTGRES_USER}
+      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
+      POSTGRES_DB: ${POSTGRES_DATABASE}
+    volumes:
+      - postgres_data:/var/lib/postgresql/data
+    ports:
+      - ${POSTGRES_PORT}:5432
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U ${POSTGRES_USER} -d ${POSTGRES_DATABASE}"]
+      interval: 10s
+      start_period: 10s
+      timeout: 10s
+      retries: 3
+
+volumes:
+  postgres_data:

haiway-0.10.11/examples/fastAPI/pyproject.toml

@@ -0,0 +1,65 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "haiway_fastapi"
+description = "Example of haiway usage with fastapi."
+version = "0.1.0"
+readme = "README.md"
+maintainers = [
+  { name = "Kacper Kaliński", email = "kacper.kalinski@miquido.com" },
+]
+requires-python = ">=3.12"
+dependencies = [
+  "haiway @ git+https://github.com/miquido/haiway@main",
+  "asyncpg~=0.30",
+  "httpx~=0.28.0",
+]
+
+[project.urls]
+Homepage = "https://miquido.com"
+
+[dependency-groups]
+server = [
+  "haiway_fastapi",
+  "fastapi-slim~=0.115",
+]
+dev = [
+  "haiway_fastapi",
+  "uvicorn~=0.30",
+  "ruff~=0.8.0",
+  "pyright~=1.1",
+  "bandit~=1.7",
+]
+
+[tool.ruff]
+target-version = "py312"
+line-length = 100
+extend-exclude = [".venv", ".git", ".cache"]
+lint.select = ["E", "F", "A", "I", "B", "PL", "W", "C", "RUF", "UP"]
+lint.ignore = []
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["F401", "E402"]
+"./tests/*.py" = ["PLR2004"]
+
+[tool.pyright]
+pythonVersion = "3.12"
+venvPath = "."
+venv = ".venv"
+include = ["./src"]
+exclude = ["**/node_modules", "**/__pycache__"]
+ignore = []
+stubPath = "./stubs"
+reportMissingImports = true
+reportMissingTypeStubs = true
+typeCheckingMode = "strict"
+userFileIndexingLimit = -1
+useLibraryCodeForTypes = true
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["src"]

haiway-0.10.11/examples/fastAPI/src/features/todos/__init__.py

@@ -0,0 +1,5 @@
+from features.todos.calls import complete_todo
+
+__all__ = [
+    "complete_todo",
+]

haiway-0.10.11/examples/fastAPI/src/features/todos/calls.py

@@ -0,0 +1,16 @@
+from uuid import UUID
+
+from haiway import ctx
+
+from features.todos.state import Todos
+
+__all__ = [
+    "complete_todo",
+]
+
+
+async def complete_todo(
+    *,
+    identifier: UUID,
+) -> None:
+    await ctx.state(Todos).complete(identifier=identifier)

haiway-0.10.11/examples/fastAPI/src/features/todos/config.py

@@ -0,0 +1 @@
+# empty

haiway-0.10.11/examples/fastAPI/src/features/todos/state.py

@@ -0,0 +1,12 @@
+from haiway import State
+
+from features.todos.types import TodoCompletion
+from features.todos.user_tasks import complete_todo_task
+
+__all__ = [
+    "Todos",
+]
+
+
+class Todos(State):
+    complete: TodoCompletion = complete_todo_task