forked from mantidproject/mantidimaging
-
Notifications
You must be signed in to change notification settings - Fork 0
/
setup.py
254 lines (209 loc) · 8.66 KB
/
setup.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
#!/usr/bin/env python
# Copyright (C) 2023 ISIS Rutherford Appleton Laboratory UKRI
# SPDX - License - Identifier: GPL-3.0-or-later
from __future__ import annotations
import fnmatch
import os
import subprocess
from distutils.core import Command
import sys
from collections import defaultdict
from pathlib import Path
import tempfile
import shutil
from importlib.machinery import SourceFileLoader
from setuptools import find_packages, setup
try:
from sphinx.setup_command import BuildDoc
except ModuleNotFoundError:
print("Warning: sphinx needed for building documentation")
BuildDoc = False
THIS_PATH = os.path.dirname(__file__)
versions = SourceFileLoader('versions', 'mantidimaging/__init__.py').load_module()
class PublishDocsToGitHubPages(Command):
description = "Deploy built documentation to GitHub Pages"
user_options = [
("repo=", "r", "Repository URL"),
("docs-dir=", "d", "Directory of documentation to publish"),
("commit-msg=", "m", "Commit message"),
]
def initialize_options(self):
self.repo = None
self.docs_dir = None
self.commit_msg = None
def finalize_options(self):
self.repo = "https://github.com/mantidproject/mantidimaging" if self.repo is None else self.repo
self.docs_dir = "docs/build/html" if self.docs_dir is None else self.docs_dir
self.commit_msg = "Publish documentation" if self.commit_msg is None else self.commit_msg
def run(self):
git_dir = os.path.join(self.docs_dir, ".git")
if os.path.exists(git_dir):
import shutil
shutil.rmtree(git_dir)
from git import Git
g = Git(self.docs_dir)
g.init()
g.checkout(b="main")
g.add(".")
g.commit("-m {}".format(self.commit_msg))
g.push("--force", self.repo, "main:gh-pages")
class GenerateSphinxApidoc(Command):
description = "Generate API documentation with sphinx-apidoc"
user_options = []
def initialize_options(self):
self.sphinx_options = []
self.module_dir = None
self.out_dir = None
def finalize_options(self):
self.sphinx_options.append("sphinx-apidoc")
self.sphinx_options.extend(["-f", "-M", "-e", "-T"])
self.sphinx_options.extend(["-d", "10"])
self.module_dir = "mantidimaging"
self.sphinx_options.append(self.module_dir)
self.sphinx_options.append("**/test")
self.sphinx_options.append("**/test_helpers")
self.sphinx_options.append("**/gui")
self.sphinx_options.append("**/core/utility")
self.sphinx_options.append("**/core/tools")
self.out_dir = "docs/api/"
self.sphinx_options.extend(["-o", self.out_dir])
def run(self):
print("Running: {}".format(" ".join(self.sphinx_options)))
subprocess.call(self.sphinx_options)
class GenerateSphinxVersioned(Command):
description = "Generate API documentation with versions in directories"
user_options = []
def initialize_options(self):
self.sphinx_multiversion_executable = None
self.sphinx_multiversion_options = None
def finalize_options(self):
self.sphinx_multiversion_executable = "sphinx-multiversion"
self.sphinx_multiversion_options = ["docs", "docs/build/html"]
def run(self):
print("Running setup.py internal_docs_api")
command_docs_api = [sys.executable, "setup.py", "internal_docs_api"]
subprocess.check_call(command_docs_api)
print("Running setup.py internal_docs")
command_docs = [sys.executable, "setup.py", "internal_docs"]
subprocess.check_call(command_docs)
print("Running sphinx-multiversion")
command_sphinx_multiversion = [self.sphinx_multiversion_executable]
command_sphinx_multiversion.extend(self.sphinx_multiversion_options)
subprocess.check_call(command_sphinx_multiversion)
class CompilePyQtUiFiles(Command):
description = "Compiles any PyQt .ui files found in the source tree"
user_options = []
def initialize_options(self):
pass
def finalize_options(self):
pass
@staticmethod
def compile_single_file(ui_filename):
from PyQt5 import uic
py_filename = os.path.splitext(ui_filename)[0] + ".py"
with open(py_filename, "w") as py_file:
uic.compileUi(ui_filename, py_file)
@staticmethod
def find_ui_files():
matches = []
for root, _, filenames in os.walk("./mantidimaging/"):
for filename in fnmatch.filter(filenames, "*.ui"):
matches.append(os.path.join(root, filename))
return matches
def run(self):
ui_files = self.find_ui_files()
for f in ui_files:
self.compile_single_file(f)
class CreateDeveloperEnvironment(Command):
description = "Install the dependencies needed to develop Mantid Imaging"
user_options = [("conda=", None, "path to conda or mamba command")]
def initialize_options(self):
mamba_path = shutil.which("mamba")
conda_path = shutil.which("conda")
if mamba_path is not None:
self.conda = mamba_path
elif conda_path is not None:
self.conda = conda_path
else:
self.conda = None
def finalize_options(self):
if self.conda is None:
raise ValueError("Could not find conda or mamba")
def count_indent(self, line):
leading_spaces = len(line) - len(line.lstrip(" "))
return leading_spaces // 2
def get_package_depends(self):
# Parse the metefile manually, do avoid needing an nonstandard library
meta_file = Path(__file__).parent / "conda" / "meta.yaml"
with meta_file.open() as meta_file_fh:
section = []
parsed_values = defaultdict(list)
for line in meta_file_fh:
# ignore templating
if line.strip() == "" or "{%" in line:
continue
if line.strip().endswith(":"):
indent = self.count_indent(line)
section = section[:indent]
section.append(line.strip(" :\n"))
else:
parsed_values[".".join(section)].append(line.strip(" -\n"))
return parsed_values["requirements.run"]
def make_environment_file(self, extra_deps):
dev_env_file = Path(__file__).parent / "environment-dev.yml"
output_env_file = tempfile.NamedTemporaryFile("wt", delete=False, suffix=".yaml")
with dev_env_file.open() as dev_env_file_fh:
for line in dev_env_file_fh:
if line.strip() == "- mantidimaging":
for extra_dep in extra_deps:
output_env_file.write(f" - {extra_dep}\n")
else:
output_env_file.write(line)
output_env_file.close()
print("Created environment file:", output_env_file.name)
return output_env_file.name
def run(self):
print("Removing existing mantidimaging-dev environment")
command_conda_env_remove = [self.conda, "env", "remove", "-n", "mantidimaging-dev"]
subprocess.check_call(command_conda_env_remove)
extra_deps = self.get_package_depends()
env_file_path = self.make_environment_file(extra_deps)
print("Creating conda environment for development")
command_conda_env = [self.conda, "env", "create", "-f", env_file_path]
subprocess.check_call(command_conda_env)
os.remove(env_file_path)
setup(
name="mantidimaging",
version=versions.__version__,
packages=find_packages(),
package_data={
"mantidimaging.gui": ["ui/*.ui", "ui/images/*.png", "windows/wizard/*.yml"],
"mantidimaging.core": ["gpu/*.cu"],
},
entry_points={
"console_scripts":
["mantidimaging-ipython = mantidimaging.ipython:main", "mantidimaging = mantidimaging.main:main"],
},
url="https://github.com/mantidproject/mantidimaging",
license="GPL-3.0",
description="Graphical toolkit for neutron imaging",
long_description=open("README.md").read(),
test_suite="nose.collector",
classifiers=[
"Programming Language :: Python :: 3.9",
"Natural Language :: English",
"Intended Audience :: Science/Research",
"Operating System :: POSIX :: Linux",
"Topic :: Scientific/Engineering",
],
cmdclass={
"internal_docs_api": GenerateSphinxApidoc,
**({
"internal_docs": BuildDoc
} if BuildDoc else {}),
"docs": GenerateSphinxVersioned,
"docs_publish": PublishDocsToGitHubPages,
"compile_ui": CompilePyQtUiFiles,
"create_dev_env": CreateDeveloperEnvironment,
},
)