pyproject.toml

# Copyright (C) 2017-2026 Bryant Moscon - bmoscon@gmail.com
#
# Please see the LICENSE file for the terms and conditions
# associated with this software.

[build-system]
requires = ["setuptools>=77.0.3", "Cython>=3.1"]
build-backend = "setuptools.build_meta"

[project]
name = "cryptofeed"
version = "3.0.2"
description = "Cryptocurrency Exchange Websocket Data Feed Handler"
readme = "README.md"
license = "AGPL-3.0-or-later"
license-files = ["LICENSE"]
authors = [
    {name = "Bryant Moscon", email = "bmoscon@gmail.com"}
]
keywords = [
    "cryptocurrency", "bitcoin", "btc", "feed handler", "market feed", "market data", "crypto assets",
    "Trades", "Tickers", "BBO", "Funding", "Open Interest", "Liquidation", "Order book", "Bid", "Ask",
    "Binance", "Binance Delivery", "Binance Futures", "Binance US", "Bitfinex", "bitFlyer", "Bitget",
    "Bithumb", "Bitstamp", "Bybit", "Coinbase", "Crypto.com", "Deribit", "Gate", "Gate Futures",
    "dYdX", "Gemini", "Hyperliquid", "HTX", "HTX Swap", "Independent Reserve", "Kraken", "Kraken Futures", "KuCoin", "MEXC",
    "OKX", "Phemex", "Poloniex", "Upbit"
]
classifiers = [
    "Intended Audience :: Developers",
    "Development Status :: 4 - Beta",
    "Programming Language :: Python :: 3 :: Only",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: 3.14",
    "Programming Language :: Python :: Free Threading :: 2 - Beta",
    "Framework :: AsyncIO",
    "Operating System :: POSIX :: Linux",
    "Operating System :: MacOS :: MacOS X",
]
requires-python = ">=3.13"
dependencies = [
    "websockets>=14.1",
    "pyyaml",
    "aiohttp>=3.14.3",
    "msgspec>=0.19.0",
    "uvloop ; platform_system!='Windows'",
    "order_book>=1.1.0",
    "aiodns>=1.1",
    "zstandard>=0.23 ; python_version<'3.14'"
]

[project.optional-dependencies]
kafka = ["aiokafka>=0.7.0"]
mongo = ["pymongo>=4.9"]
postgres = ["asyncpg"]
redis = ["hiredis", "redis>=4.5.1"]
zmq = ["pyzmq"]
all = [
    "aiokafka>=0.7.0",
    "pymongo>=4.9",
    "asyncpg",
    "hiredis",
    "redis>=4.5.1",
    "pyzmq",
    "zstandard ; python_version < '3.14'",
]

[project.urls]
Homepage = "https://github.com/bmoscon/cryptofeed"

[dependency-groups]
dev = [
    "aiokafka>=0.13.0",
    "asyncpg>=0.31.0",
    "pymongo>=4.9",
    "pytest",
    "pytest-asyncio",
    "pytest-benchmark>=5.2.3",
    "pytest-timeout>=2.4.0",
    "pyzmq>=27.1.0",
    "redis",
    "ruff",
    "zstandard ; python_version < '3.14'",
]

[tool.setuptools.packages.find]
include = ["cryptofeed*"]

[tool.setuptools.package-data]
cryptofeed = ["*.pyx", "py.typed", "types.pyi"]

# For a debug build that keeps the runtime assertions, remove the CYTHON_WITHOUT_ASSERTIONS macro and rebuild
[[tool.setuptools.ext-modules]]
name = "cryptofeed.types"
sources = ["cryptofeed/types.pyx"]
define-macros = [["CYTHON_WITHOUT_ASSERTIONS", ""]]

[tool.cibuildwheel]
build = "cp313-* cp314-* cp314t-*"
skip = "*musllinux*"
test-command = "python -c \"import sys, sysconfig; from cryptofeed import FeedHandler; from cryptofeed.types import COMPILED_WITH_ASSERTIONS; assert COMPILED_WITH_ASSERTIONS is False; assert not (sysconfig.get_config_var('Py_GIL_DISABLED') and sys._is_gil_enabled()), 'importing cryptofeed re-enabled the GIL'\""

[tool.cibuildwheel.linux]
archs = ["x86_64"]

[tool.cibuildwheel.macos]
archs = ["arm64"]

[tool.ruff.lint]
select = ["E", "F", "W", "ASYNC"]
ignore = ["E501", "F403", "F405"]

[tool.ruff.lint.per-file-ignores]
"__init__.py" = ["F401"]

[tool.pytest.ini_options]
markers = [
    "unit: unit tests",
    "playback: replay recorded exchange data through the message handlers",
    "backend: requires backend services",
    "live: hits exchange endpoints",
    "bench: performance tests and benchmarks",
]
addopts = "-m 'not live'"
asyncio_mode = "auto"
# a replay that hangs should fail
timeout = 600