Installation¶

Requirements¶

Python 3.10+
Compatible with asyncio and anyio (Trio support)

Quick Install¶

Using pip (most common):

pip install effectpy

Using uv (recommended for new projects):

uv add effectpy

Using conda:

# Coming soon to conda-forge
pip install effectpy

Optional Dependencies¶

effectpy has several optional dependencies for enhanced functionality:

AnyIO Runtime¶

For Trio/AnyIO backend support:

With pip:

pip install effectpy[anyio]

With uv:

uv add "effectpy[anyio]"

Exporters¶

For OpenTelemetry HTTP exporters (requires aiohttp):

With pip:

pip install effectpy[exporters]

With uv:

uv add "effectpy[exporters]"

All Optional Dependencies¶

With pip:

pip install effectpy[anyio,exporters]

With uv:

uv add "effectpy[anyio,exporters]"

Development Installation¶

For contributing or running examples:

Using uv (recommended):

git clone https://github.com/stukennedy/effectpy.git
cd effectpy
uv sync

Using pip:

git clone https://github.com/stukennedy/effectpy.git
cd effectpy
pip install -e ".[anyio,exporters,docs]"

Verify Installation¶

Create a simple test file to verify your installation:

test_effectpy.py

import asyncio
from effectpy import *

async def main():
    # Simple effect composition
    result = await succeed(42).map(lambda x: x * 2)._run(Context())
    print(f"Effect result: {result}")  # Should print: Effect result: 84

    # Test resource management
    scope = Scope()
    env = await LoggerLayer.build_scoped(Context(), scope)

    instrumented = instrument("test", succeed("Hello effectpy!"))
    message = await instrumented._run(env)
    print(f"Instrumented: {message}")

    await scope.close()

if __name__ == "__main__":
    asyncio.run(main())

Run it:

python test_effectpy.py

Expected output:

Effect result: 84
Instrumented: Hello effectpy!

What's Next?¶

Troubleshooting¶

Python Version Issues¶

Make sure you're using Python 3.10+:

python --version  # Should be 3.10.0 or higher

Import Errors¶

If you see import errors, try:

Reinstall effectpy: pip uninstall effectpy && pip install effectpy
Check virtual environment: Make sure you're in the correct virtual environment
Clear Python cache: python -Bc "import sys; print(sys.path)"

Optional Dependencies Not Found¶

If optional features don't work:

# Check what's installed
pip show effectpy

# Install missing extras
pip install effectpy[anyio,exporters]