pyproject.toml 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284
  1. [tool.towncrier]
  2. package = "synapse"
  3. filename = "CHANGES.md"
  4. directory = "changelog.d"
  5. issue_format = "[\\#{issue}](https://github.com/matrix-org/synapse/issues/{issue})"
  6. [[tool.towncrier.type]]
  7. directory = "feature"
  8. name = "Features"
  9. showcontent = true
  10. [[tool.towncrier.type]]
  11. directory = "bugfix"
  12. name = "Bugfixes"
  13. showcontent = true
  14. [[tool.towncrier.type]]
  15. directory = "docker"
  16. name = "Updates to the Docker image"
  17. showcontent = true
  18. [[tool.towncrier.type]]
  19. directory = "doc"
  20. name = "Improved Documentation"
  21. showcontent = true
  22. [[tool.towncrier.type]]
  23. directory = "removal"
  24. name = "Deprecations and Removals"
  25. showcontent = true
  26. [[tool.towncrier.type]]
  27. directory = "misc"
  28. name = "Internal Changes"
  29. showcontent = true
  30. [tool.black]
  31. target-version = ['py37', 'py38', 'py39', 'py310']
  32. # black ignores everything in .gitignore by default, see
  33. # https://black.readthedocs.io/en/stable/usage_and_configuration/file_collection_and_discovery.html#gitignore
  34. # Use `extend-exclude` if you want to exclude something in addition to this.
  35. [tool.isort]
  36. line_length = 88
  37. sections = ["FUTURE", "STDLIB", "THIRDPARTY", "TWISTED", "FIRSTPARTY", "TESTS", "LOCALFOLDER"]
  38. default_section = "THIRDPARTY"
  39. known_first_party = ["synapse"]
  40. known_tests = ["tests"]
  41. known_twisted = ["twisted", "OpenSSL"]
  42. multi_line_output = 3
  43. include_trailing_comma = true
  44. combine_as_imports = true
  45. skip_gitignore = true
  46. [tool.poetry]
  47. name = "matrix-synapse"
  48. version = "1.63.0"
  49. description = "Homeserver for the Matrix decentralised comms protocol"
  50. authors = ["Matrix.org Team and Contributors <packages@matrix.org>"]
  51. license = "Apache-2.0"
  52. readme = "README.rst"
  53. repository = "https://github.com/matrix-org/synapse"
  54. packages = [
  55. { include = "synapse" },
  56. ]
  57. classifiers = [
  58. "Development Status :: 5 - Production/Stable",
  59. "Topic :: Communications :: Chat",
  60. ]
  61. include = [
  62. { path = "AUTHORS.rst", format = "sdist" },
  63. { path = "book.toml", format = "sdist" },
  64. { path = "changelog.d", format = "sdist" },
  65. { path = "CHANGES.md", format = "sdist" },
  66. { path = "CONTRIBUTING.md", format = "sdist" },
  67. { path = "demo", format = "sdist" },
  68. { path = "docs", format = "sdist" },
  69. { path = "INSTALL.md", format = "sdist" },
  70. { path = "mypy.ini", format = "sdist" },
  71. { path = "scripts-dev", format = "sdist" },
  72. { path = "synmark", format="sdist" },
  73. { path = "sytest-blacklist", format = "sdist" },
  74. { path = "tests", format = "sdist" },
  75. { path = "UPGRADE.rst", format = "sdist" },
  76. ]
  77. [tool.poetry.scripts]
  78. synapse_homeserver = "synapse.app.homeserver:main"
  79. synapse_worker = "synapse.app.generic_worker:main"
  80. synctl = "synapse._scripts.synctl:main"
  81. export_signing_key = "synapse._scripts.export_signing_key:main"
  82. generate_config = "synapse._scripts.generate_config:main"
  83. generate_log_config = "synapse._scripts.generate_log_config:main"
  84. generate_signing_key = "synapse._scripts.generate_signing_key:main"
  85. hash_password = "synapse._scripts.hash_password:main"
  86. register_new_matrix_user = "synapse._scripts.register_new_matrix_user:main"
  87. synapse_port_db = "synapse._scripts.synapse_port_db:main"
  88. synapse_review_recent_signups = "synapse._scripts.review_recent_signups:main"
  89. update_synapse_database = "synapse._scripts.update_synapse_database:main"
  90. [tool.poetry.dependencies]
  91. python = "^3.7.1"
  92. # Mandatory Dependencies
  93. # ----------------------
  94. # we use the TYPE_CHECKER.redefine method added in jsonschema 3.0.0
  95. jsonschema = ">=3.0.0"
  96. # frozendict 2.1.2 is broken on Debian 10: https://github.com/Marco-Sulla/python-frozendict/issues/41
  97. frozendict = ">=1,!=2.1.2"
  98. # We require 2.1.0 or higher for type hints. Previous guard was >= 1.1.0
  99. unpaddedbase64 = ">=2.1.0"
  100. canonicaljson = "^1.4.0"
  101. # we use the type definitions added in signedjson 1.1.
  102. signedjson = "^1.1.0"
  103. # validating SSL certs for IP addresses requires service_identity 18.1.
  104. service-identity = ">=18.1.0"
  105. # Twisted 18.9 introduces some logger improvements that the structured
  106. # logger utilises
  107. Twisted = {extras = ["tls"], version = ">=18.9.0"}
  108. treq = ">=15.1"
  109. # Twisted has required pyopenssl 16.0 since about Twisted 16.6.
  110. pyOpenSSL = ">=16.0.0"
  111. PyYAML = ">=3.11"
  112. pyasn1 = ">=0.1.9"
  113. pyasn1-modules = ">=0.0.7"
  114. bcrypt = ">=3.1.0"
  115. Pillow = ">=5.4.0"
  116. sortedcontainers = ">=1.4.4"
  117. pymacaroons = ">=0.13.0"
  118. msgpack = ">=0.5.2"
  119. phonenumbers = ">=8.2.0"
  120. # we use GaugeHistogramMetric, which was added in prom-client 0.4.0.
  121. prometheus-client = ">=0.4.0"
  122. # we use `order`, which arrived in attrs 19.2.0.
  123. # Note: 21.1.0 broke `/sync`, see #9936
  124. attrs = ">=19.2.0,!=21.1.0"
  125. netaddr = ">=0.7.18"
  126. # Jinja 2.x is incompatible with MarkupSafe>=2.1. To ensure that admins do not
  127. # end up with a broken installation, with recent MarkupSafe but old Jinja, we
  128. # add a lower bound to the Jinja2 dependency.
  129. Jinja2 = ">=3.0"
  130. bleach = ">=1.4.3"
  131. # We use `ParamSpec` and `Concatenate`, which were added in `typing-extensions` 3.10.0.0.
  132. # Additionally we need https://github.com/python/typing/pull/817 to allow types to be
  133. # generic over ParamSpecs.
  134. typing-extensions = ">=3.10.0.1"
  135. # We enforce that we have a `cryptography` version that bundles an `openssl`
  136. # with the latest security patches.
  137. cryptography = ">=3.4.7"
  138. # ijson 3.1.4 fixes a bug with "." in property names
  139. ijson = ">=3.1.4"
  140. matrix-common = "^1.2.1"
  141. # We need packaging.requirements.Requirement, added in 16.1.
  142. packaging = ">=16.1"
  143. # At the time of writing, we only use functions from the version `importlib.metadata`
  144. # which shipped in Python 3.8. This corresponds to version 1.4 of the backport.
  145. importlib_metadata = { version = ">=1.4", python = "<3.8" }
  146. # Optional Dependencies
  147. # ---------------------
  148. matrix-synapse-ldap3 = { version = ">=0.1", optional = true }
  149. psycopg2 = { version = ">=2.8", markers = "platform_python_implementation != 'PyPy'", optional = true }
  150. psycopg2cffi = { version = ">=2.8", markers = "platform_python_implementation == 'PyPy'", optional = true }
  151. psycopg2cffi-compat = { version = "==1.1", markers = "platform_python_implementation == 'PyPy'", optional = true }
  152. pysaml2 = { version = ">=4.5.0", optional = true }
  153. authlib = { version = ">=0.14.0", optional = true }
  154. # systemd-python is necessary for logging to the systemd journal via
  155. # `systemd.journal.JournalHandler`, as is documented in
  156. # `contrib/systemd/log_config.yaml`.
  157. # Note: systemd-python 231 appears to have been yanked from pypi
  158. systemd-python = { version = ">=231", optional = true }
  159. lxml = { version = ">=4.2.0", optional = true }
  160. sentry-sdk = { version = ">=0.7.2", optional = true }
  161. opentracing = { version = ">=2.2.0", optional = true }
  162. jaeger-client = { version = ">=4.0.0", optional = true }
  163. txredisapi = { version = ">=1.4.7", optional = true }
  164. hiredis = { version = "*", optional = true }
  165. Pympler = { version = "*", optional = true }
  166. parameterized = { version = ">=0.7.4", optional = true }
  167. idna = { version = ">=2.5", optional = true }
  168. [tool.poetry.extras]
  169. # NB: Packages that should be part of `pip install matrix-synapse[all]` need to be specified
  170. # twice: once here, and once in the `all` extra.
  171. matrix-synapse-ldap3 = ["matrix-synapse-ldap3"]
  172. postgres = ["psycopg2", "psycopg2cffi", "psycopg2cffi-compat"]
  173. saml2 = ["pysaml2"]
  174. oidc = ["authlib"]
  175. # systemd-python is necessary for logging to the systemd journal via
  176. # `systemd.journal.JournalHandler`, as is documented in
  177. # `contrib/systemd/log_config.yaml`.
  178. systemd = ["systemd-python"]
  179. url_preview = ["lxml"]
  180. sentry = ["sentry-sdk"]
  181. opentracing = ["jaeger-client", "opentracing"]
  182. jwt = ["authlib"]
  183. # hiredis is not a *strict* dependency, but it makes things much faster.
  184. # (if it is not installed, we fall back to slow code.)
  185. redis = ["txredisapi", "hiredis"]
  186. # Required to use experimental `caches.track_memory_usage` config option.
  187. cache_memory = ["pympler"]
  188. test = ["parameterized", "idna"]
  189. # The duplication here is awful. I hate hate hate hate hate it. However, for now I want
  190. # to ensure you can still `pip install matrix-synapse[all]` like today. Two motivations:
  191. # 1) for new installations, I want instructions in existing documentation and tutorials
  192. # out there to still work.
  193. # 2) I don't want to hard-code a list of extras into CI if I can help it. The ideal
  194. # solution here would be something like https://github.com/python-poetry/poetry/issues/3413
  195. # Poetry 1.2's dependency groups might make this easier. But I'm not trying that out
  196. # until there's a stable release of 1.2.
  197. #
  198. # NB: the strings in this list must be *package* names, not extra names.
  199. # Some of our extra names _are_ package names, which can lead to great confusion.
  200. all = [
  201. # matrix-synapse-ldap3
  202. "matrix-synapse-ldap3",
  203. # postgres
  204. "psycopg2", "psycopg2cffi", "psycopg2cffi-compat",
  205. # saml2
  206. "pysaml2",
  207. # oidc and jwt
  208. "authlib",
  209. # url_preview
  210. "lxml",
  211. # sentry
  212. "sentry-sdk",
  213. # opentracing
  214. "jaeger-client", "opentracing",
  215. # redis
  216. "txredisapi", "hiredis",
  217. # cache_memory
  218. "pympler",
  219. # omitted:
  220. # - test: it's useful to have this separate from dev deps in the olddeps job
  221. # - systemd: this is a system-based requirement
  222. ]
  223. [tool.poetry.dev-dependencies]
  224. ## We pin black so that our tests don't start failing on new releases.
  225. isort = "==5.7.0"
  226. black = "==22.3.0"
  227. flake8-comprehensions = "*"
  228. flake8-bugbear = "==21.3.2"
  229. flake8 = "*"
  230. # Typechecking
  231. mypy = "*"
  232. mypy-zope = "*"
  233. types-bleach = ">=4.1.0"
  234. types-commonmark = ">=0.9.2"
  235. types-jsonschema = ">=3.2.0"
  236. types-opentracing = ">=2.4.2"
  237. types-Pillow = ">=8.3.4"
  238. types-psycopg2 = ">=2.9.9"
  239. types-pyOpenSSL = ">=20.0.7"
  240. types-PyYAML = ">=5.4.10"
  241. types-requests = ">=2.26.0"
  242. types-setuptools = ">=57.4.0"
  243. # Dependencies which are exclusively required by unit test code. This is
  244. # NOT a list of all modules that are necessary to run the unit tests.
  245. # Tests assume that all optional dependencies are installed.
  246. # parameterized<0.7.4 can create classes with names that would normally be invalid
  247. # identifiers. trial really does not like this when running with multiple workers.
  248. parameterized = ">=0.7.4"
  249. idna = ">=2.5"
  250. # The following are used by the release script
  251. click = "==8.1.1"
  252. # GitPython was == 3.1.14; bumped to 3.1.20, the first release with type hints.
  253. GitPython = ">=3.1.20"
  254. commonmark = "==0.9.1"
  255. pygithub = "==1.55"
  256. # The following are executed as commands by the release script.
  257. twine = "*"
  258. # Towncrier min version comes from #3425. Rationale unclear.
  259. towncrier = ">=18.6.0rc1"
  260. [build-system]
  261. requires = ["poetry-core>=1.0.0"]
  262. build-backend = "poetry.core.masonry.api"