pyproject.toml

[project]
name = "elfpy"
version = "0.2.0"
authors = [
    { name = "Dylan Paiton", email = "dylan@delv.tech" },
    { name = "Mihai Cosma", email = "mihai@delv.tech" },
    { name = "Jonny Rhea", email = "jonny@delv.tech" },
    { name = "Matthew Brown", email = "matt@delv.tech" },
    { name = "Alex Towle", email = "alex@delv.tech" },
    { name = "Sheng Lundquist", email = "sheng@delv.tech" },
    { name = "Patrick Morris", email = "patrick@delv.tech" },
    { name = "Giovanni Effio", email = "mazygio@delv.tech" },
    { name = "Ryan Goree", email = "ryan@delv.tech" },
    { name = "Will Villanueva", email = "will@delv.tech" },
    { name = "Jacob Arruda", email = "jacob@delv.tech" },
    { name = "Violet Vienhage", email = "violet@delv.tech" },
]
description = "Experiment management and market simulators by Delv"
readme = "README.md"
requires-python = ">=3.10, <3.11"
classifiers = [
    "Programming Language :: Python :: 3",
    "License :: OSI Approved :: Apache License 2.0",
    "Operating System :: OS Independent",
]
line-length = "120"

[project.optional-dependencies]
with-dependencies = [
    # Specify requirements
    "astunparse",
    "black",
    "eth-ape",
    "ipython",
    "jupytext",
    # Install fixedpointmath from github
    # Note that this is pointing to main, so if any changes are made to fixedpointmath, we'll have to
    # upgrade this package
    "fixedpointmath @ git+https://github.com/delvtech/agent_0.git/#subdirectory=lib/fixedpointmath",
    "matplotlib",
    "nbconvert",
    "numpy",
    "pandas",
    "pylint",
    "pyright",
    "pytest",
    "python-dotenv",
    "ruff",
    "scipy",
    "typing_extensions==4.5.0",
    # bot dependencies
    "web3",
    "streamlit",
    "mplfinance",
    "flask",
    "psycopg2-binary",
    "sqlalchemy",
]

docs = [
    "tomli>=2.0.1",
    "sphinx>=6",
    "sphinx_autodoc_typehints>=1.21.8",
    "sphinx-autoapi>=2.0.1",
    "myst-parser>=2.0.0",
    "numpydoc>=1.5.0",
    "sphinxcontrib-napoleon>=0.7",
    "autodocsumm>=0.2.11",
    "nbsphinx>=0.8.12",
    "sphinx-rtd-theme>=1.2.2",
    # urllib3 v2 requires OpenSSL v1.1.1+, but Vercel uses v1.0.2
    "urllib3<2.0",
]

ape = [
    "ape-alchemy",
    "ape-etherscan",
    "ape-foundry",
    "ape-solidity",
    "eth-ape",
]

[project.urls]
"Homepage" = "https://github.com/delvtech/elf-simulations"
"Bug Tracker" = "https://github.com/delvtech/elf-simulations/issues"

[build-system]
requires = ["flit_core>=3.2"]
build-backend = "flit_core.buildapi"

[tool.pytest.ini_options]
addopts = ["--import-mode=importlib"]

[tool.pylint.format]
max-line-length = "120"

[tool.black]
line-length = "120"
extend-exclude = "\\.ipynb"

[tool.pylance]
exclude = [
    "agent_0",
    "hyperdrive_solidity",
]

[tool.pyright]
exclude = [
    "agent_0",
    ".venv",
    ".vscode",
    "docs",
    "hyperdrive_solidity/.venv",
    "hyperdrive_solidity",
]

[tool.ruff]
# Default is: pycodestyle (E) and Pyflakes (F)
# We add flake8-builtins (A), pydocstyle (D), isort (I), pep8-naming (N), and pylint (PL).
# We remove pycodestyle (E) since it throws erroneous line too long errors.
# We remove Pyflakes (F) since it complains about `import *` which we need.
select = ["A", "D", "I", "N", "PL"]

# We ignore the following rules:
# D203 : 1 blank line required before class docstring (incompatible with D211: no blank lines before class docstring)
# D213: multi-line-summary-second-line (incompatible with D212: multi-line summary should start at the first line)
# D416: section-name-ends-in-colon (numpy style guide doesn't use colons after sections, i.e. Parameters)
# PLR0913 : Too many arguments to function call (X > 5)
# PLR0915 : Too many statements (X > 50)
# PLR0912 : Too many branches (X > 12)
ignore = ["D203", "D213", "D416", "PLR0913", "PLR0915", "PLR0912"]

# Allow autofix for all enabled rules (when `--fix`) is provided.
fixable = ["A", "D", "I", "N", "PL"]
unfixable = []

# override pow in fixed_point, and allow literal comparison in tests
# per-file-ignores = { "elfpy/utils/math/fixed_point.py" = [
#     "A003",
# ], "tests/*" = [
#     "PLR2004",
# ] }

# Ignore builtins in elfpy/utils/math/fixed_point.py
line-length = 120

# Allow unused variables when underscore-prefixed.
dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"

# Assume Python 3.10.
target-version = "py310"

exclude = [
    ".venv",
    ".vscode",
    "docs",
    "hyperdrive_solidity/.venv",
    "hyperdrive_solidity",
]