176 lines
5.5 KiB
TOML
176 lines
5.5 KiB
TOML
[project]
|
|
name = "blender_maxwell"
|
|
version = "0.1.0"
|
|
description = "Real-time design and visualization of Maxwell simulations in Blender 3D, with deep Tidy3D integration. "
|
|
authors = [
|
|
{ name = "Sofus Albert Høgsbro Rose", email = "blender-maxwell@sofusrose.com" }
|
|
]
|
|
dependencies = [
|
|
"tidy3d>=2.6.3",
|
|
"pydantic>=2.7.1",
|
|
"sympy==1.12",
|
|
"scipy==1.12.*",
|
|
"trimesh==4.2.*",
|
|
"networkx==3.2.*",
|
|
"rich==12.5.*",
|
|
"rtree==1.2.*",
|
|
"jax[cpu]==0.4.26",
|
|
"msgspec[toml]==0.18.6",
|
|
"numba==0.59.1",
|
|
"jaxtyping==0.2.28",
|
|
# Pin Blender 4.1.0-Compatible Versions
|
|
## The dependency resolver will report if anything is wonky.
|
|
"urllib3==1.26.8",
|
|
#"requests==2.27.1", ## Conflict with dev-dep commitizen
|
|
"numpy==1.24.3",
|
|
"idna==3.3",
|
|
#"charset-normalizer==2.0.10", ## Conflict with dev-dep commitizen
|
|
"certifi==2021.10.8",
|
|
]
|
|
## When it comes to dev-dep conflicts:
|
|
## -> It's okay to leave Blender-pinned deps out of prod; Blender still has them.
|
|
## -> In edge cases, other deps might grab newer versions and Blender will complain.
|
|
## -> Let's wait and see if this is more than a theoretical issue.
|
|
readme = "README.md"
|
|
requires-python = "~= 3.11"
|
|
license = { text = "AGPL-3.0-or-later" }
|
|
|
|
####################
|
|
# - Tooling: Rye
|
|
####################
|
|
[tool.rye]
|
|
managed = true
|
|
virtual = true
|
|
dev-dependencies = [
|
|
"ruff>=0.4.3",
|
|
"fake-bpy-module-4-0>=20231118",
|
|
"pre-commit>=3.7.0",
|
|
"commitizen>=3.25.0",
|
|
## Requires charset-normalizer>=2.1.0
|
|
# Required by Commitizen
|
|
## -> It's okay to have different dev/prod versions in our use case.
|
|
"charset-normalizer==2.1.*",
|
|
## Manually scanned CHANGELOG; seems compatible.
|
|
]
|
|
|
|
[tool.rye.scripts]
|
|
dev = "python ./src/scripts/dev.py"
|
|
pack = "python ./src/scripts/pack.py"
|
|
|
|
|
|
####################
|
|
# - Tooling: Ruff
|
|
####################
|
|
[tool.ruff]
|
|
target-version = "py311"
|
|
line-length = 88
|
|
pycodestyle.max-doc-length = 120
|
|
|
|
[tool.ruff.lint]
|
|
task-tags = ["TODO"]
|
|
select = [
|
|
"E", # pycodestyle ## General Purpose
|
|
"F", # pyflakes ## General Purpose
|
|
"PL", # Pylint ## General Purpose
|
|
|
|
## Code Quality
|
|
"TCH", # flake8-type-checking ## Type Checking Block Validator
|
|
"C90", # mccabe ## Avoid Too-Complex Functions
|
|
"ERA", # eradicate ## Ban Commented Code
|
|
"TRY", # tryceratops ## Exception Handling Style
|
|
"B", # flake8-bugbear ## Opinionated, Probable-Bug Patterns
|
|
"N", # pep8-naming
|
|
"D", # pydocstyle
|
|
"SIM", # flake8-simplify ## Sanity-Check for Code Simplification
|
|
"SLF", # flake8-self ## Ban Private Member Access
|
|
"RUF", # Ruff-specific rules ## Extra Good-To-Have Rules
|
|
|
|
## Style
|
|
"I", # isort ## Force import Sorting
|
|
"UP", # pyupgrade ## Enforce Upgrade to Newer Python Syntaxes
|
|
"COM", # flake8-commas ## Enforce Trailing Commas
|
|
"Q", # flake8-quotes ## Finally - Quoting Style!
|
|
"PTH", # flake8-use-pathlib ## Enforce pathlib usage
|
|
"A", # flake8-builtins ## Prevent Builtin Shadowing
|
|
"C4", # flake9-comprehensions ## Check Compehension Appropriateness
|
|
"DTZ", # flake8-datetimez ## Ban naive Datetime Creation
|
|
"EM", # flake8-errmsg ## Check Exception String Formatting
|
|
"ISC", # flake8-implicit-str-concat ## Enforce Good String Literal Concat
|
|
"G", # flake8-logging-format ## Enforce Good Logging Practices
|
|
"INP", # flake8-no-pep420 ## Ban PEP420; Enforce __init__.py.
|
|
"PIE", # flake8-pie ## Misc Opinionated Checks
|
|
"T20", # flake8-print ## Ban print()
|
|
"RSE", # flake8-raise ## Check Niche Exception Raising Pattern
|
|
"RET", # flake8-return ## Enforce Good Returning
|
|
"ARG", # flake8-unused-arguments ## Ban Unused Arguments
|
|
|
|
# Specific
|
|
"PT", # flake8-pytest-style ## pytest-Specific Checks
|
|
]
|
|
ignore = [
|
|
"COM812", # Conflicts w/Formatter
|
|
"ISC001", # Conflicts w/Formatter
|
|
"Q000", # Conflicts w/Formatter
|
|
"Q001", # Conflicts w/Formatter
|
|
"Q002", # Conflicts w/Formatter
|
|
"Q003", # Conflicts w/Formatter
|
|
"D206", # Conflicts w/Formatter
|
|
"B008", # FastAPI uses this for Depends(), Security(), etc. .
|
|
"E701", # class foo(Parent): pass or if simple: return are perfectly elegant
|
|
"ERA001", # 'Commented-out code' seems to be just about anything to ruff
|
|
"F722", # jaxtyping uses type annotations that ruff sees as "syntax error"
|
|
"N806", # Sometimes we like using types w/uppercase in functions, sue me
|
|
"RUF001", # We use a lot of unicode, yes, on purpose!
|
|
|
|
# Line Length - Controversy Incoming
|
|
## Hot Take: Let the Formatter Worry about Line Length
|
|
## - Yes dear reader, I'm with you. Soft wrap can go too far.
|
|
## - ...but also, sometimes there are real good reasons not to split.
|
|
## - Ex. I think 'one sentence per line' docstrings are a valid thing.
|
|
## - Overlong lines tend to be be a code smell anyway
|
|
## - We'll see if my hot takes survive the week :)
|
|
"E501", # Let Formatter Worry about Line Length
|
|
]
|
|
|
|
####################
|
|
# - Tooling: Ruff Sublinters
|
|
####################
|
|
[tool.ruff.lint.flake8-bugbear]
|
|
extend-immutable-calls = []
|
|
|
|
[tool.ruff.lint.pycodestyle]
|
|
ignore-overlong-task-comments = true
|
|
|
|
[tool.ruff.lint.pydocstyle]
|
|
convention = "google"
|
|
|
|
[tool.ruff.lint.pylint]
|
|
max-args = 6
|
|
|
|
####################
|
|
# - Tooling: Ruff Formatter
|
|
####################
|
|
[tool.ruff.format]
|
|
quote-style = "single"
|
|
indent-style = "tab"
|
|
docstring-code-format = false
|
|
|
|
####################
|
|
# - Tooling: Commits
|
|
####################
|
|
[tool.commitizen]
|
|
# Specification
|
|
name = "cz_conventional_commits"
|
|
version_scheme = "semver2"
|
|
version_provider = "pep621"
|
|
tag_format = "v$version"
|
|
|
|
# Version Bumping
|
|
retry_after_failure = true
|
|
major_version_zero = true
|
|
update_changelog_on_bump = true
|
|
|
|
# Annotations / Signature
|
|
gpg_sign = true
|
|
annotated_tag = true
|