setup.py 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137
  1. #!/usr/bin/env python
  2. # Copyright 2014-2017 OpenMarket Ltd
  3. # Copyright 2017 Vector Creations Ltd
  4. # Copyright 2017-2018 New Vector Ltd
  5. #
  6. # Licensed under the Apache License, Version 2.0 (the "License");
  7. # you may not use this file except in compliance with the License.
  8. # You may obtain a copy of the License at
  9. #
  10. # http://www.apache.org/licenses/LICENSE-2.0
  11. #
  12. # Unless required by applicable law or agreed to in writing, software
  13. # distributed under the License is distributed on an "AS IS" BASIS,
  14. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15. # See the License for the specific language governing permissions and
  16. # limitations under the License.
  17. import glob
  18. import os
  19. from setuptools import Command, find_packages, setup
  20. here = os.path.abspath(os.path.dirname(__file__))
  21. # Some notes on `setup.py test`:
  22. #
  23. # Once upon a time we used to try to make `setup.py test` run `tox` to run the
  24. # tests. That's a bad idea for three reasons:
  25. #
  26. # 1: `setup.py test` is supposed to find out whether the tests work in the
  27. # *current* environmentt, not whatever tox sets up.
  28. # 2: Empirically, trying to install tox during the test run wasn't working ("No
  29. # module named virtualenv").
  30. # 3: The tox documentation advises against it[1].
  31. #
  32. # Even further back in time, we used to use setuptools_trial [2]. That has its
  33. # own set of issues: for instance, it requires installation of Twisted to build
  34. # an sdist (because the recommended mode of usage is to add it to
  35. # `setup_requires`). That in turn means that in order to successfully run tox
  36. # you have to have the python header files installed for whichever version of
  37. # python tox uses (which is python3 on recent ubuntus, for example).
  38. #
  39. # So, for now at least, we stick with what appears to be the convention among
  40. # Twisted projects, and don't attempt to do anything when someone runs
  41. # `setup.py test`; instead we direct people to run `trial` directly if they
  42. # care.
  43. #
  44. # [1]: http://tox.readthedocs.io/en/2.5.0/example/basic.html#integration-with-setup-py-test-command
  45. # [2]: https://pypi.python.org/pypi/setuptools_trial
  46. class TestCommand(Command):
  47. user_options = []
  48. def initialize_options(self):
  49. pass
  50. def finalize_options(self):
  51. pass
  52. def run(self):
  53. print(
  54. """Synapse's tests cannot be run via setup.py. To run them, try:
  55. PYTHONPATH="." trial tests
  56. """
  57. )
  58. def read_file(path_segments):
  59. """Read a file from the package. Takes a list of strings to join to
  60. make the path"""
  61. file_path = os.path.join(here, *path_segments)
  62. with open(file_path) as f:
  63. return f.read()
  64. def exec_file(path_segments):
  65. """Execute a single python file to get the variables defined in it"""
  66. result = {}
  67. code = read_file(path_segments)
  68. exec(code, result)
  69. return result
  70. version = exec_file(("synapse", "__init__.py"))["__version__"]
  71. dependencies = exec_file(("synapse", "python_dependencies.py"))
  72. long_description = read_file(("README.rst",))
  73. REQUIREMENTS = dependencies["REQUIREMENTS"]
  74. CONDITIONAL_REQUIREMENTS = dependencies["CONDITIONAL_REQUIREMENTS"]
  75. ALL_OPTIONAL_REQUIREMENTS = dependencies["ALL_OPTIONAL_REQUIREMENTS"]
  76. # Make `pip install matrix-synapse[all]` install all the optional dependencies.
  77. CONDITIONAL_REQUIREMENTS["all"] = list(ALL_OPTIONAL_REQUIREMENTS)
  78. # Developer dependencies should not get included in "all".
  79. #
  80. # We pin black so that our tests don't start failing on new releases.
  81. CONDITIONAL_REQUIREMENTS["lint"] = [
  82. "isort==5.0.3",
  83. "black==19.10b0",
  84. "flake8-comprehensions",
  85. "flake8",
  86. ]
  87. CONDITIONAL_REQUIREMENTS["mypy"] = ["mypy==0.790", "mypy-zope==0.2.8"]
  88. # Dependencies which are exclusively required by unit test code. This is
  89. # NOT a list of all modules that are necessary to run the unit tests.
  90. # Tests assume that all optional dependencies are installed.
  91. #
  92. # parameterized_class decorator was introduced in parameterized 0.7.0
  93. CONDITIONAL_REQUIREMENTS["test"] = ["mock>=2.0", "parameterized>=0.7.0"]
  94. setup(
  95. name="matrix-synapse",
  96. version=version,
  97. packages=find_packages(exclude=["tests", "tests.*"]),
  98. description="Reference homeserver for the Matrix decentralised comms protocol",
  99. install_requires=REQUIREMENTS,
  100. extras_require=CONDITIONAL_REQUIREMENTS,
  101. include_package_data=True,
  102. zip_safe=False,
  103. long_description=long_description,
  104. python_requires="~=3.5",
  105. classifiers=[
  106. "Development Status :: 5 - Production/Stable",
  107. "Topic :: Communications :: Chat",
  108. "License :: OSI Approved :: Apache Software License",
  109. "Programming Language :: Python :: 3 :: Only",
  110. "Programming Language :: Python :: 3.5",
  111. "Programming Language :: Python :: 3.6",
  112. "Programming Language :: Python :: 3.7",
  113. "Programming Language :: Python :: 3.8",
  114. ],
  115. scripts=["synctl"] + glob.glob("scripts/*"),
  116. cmdclass={"test": TestCommand},
  117. )