-
Notifications
You must be signed in to change notification settings - Fork 42
/
setup.py
210 lines (173 loc) · 7.2 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
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
Setup file for wafo.
Usage:
Run all tests:
python setup.py test
python setup.py doctest
Build documentation
python setup.py docs
python setup.py latex
Install
python setup.py install [, --prefix=$PREFIX]
Build
python setup.py bdist_wininst
python setup.py bdist_wheel
python setup.py sdist
Recommended build
git pull origin
git shortlog v0.9.20..HEAD -w80 --format="* %s" --reverse > log.txt
# update CHANGELOG.rst with info from log.txt
python build_package.py 0.10.0rc0
git commit
git tag v0.10.0rc0 master
git push --tags
PyPi upload:
twine check dist/* # check
twine upload dist/* # wait until the travis report is OK before doing this step.
Notes
-----
Don't use package_data and/or data_files, use include_package_data=True and MANIFEST.in instead!
Don't hard-code the list of packages, use setuptools.find_packages() instead!
See also
--------
https://docs.pytest.org/en/latest/goodpractices.html
https://python-packaging.readthedocs.io/en/latest/
https://packaging.python.org/en/latest/distributing.html
https://github.com/pypa/sampleproject
https://chriswarrick.com/blog/2014/09/15/python-apps-the-right-way-entry_points-and-scripts/
https://blog.ionelmc.ro/2014/05/25/python-packaging/#the-structure
https://ep2015.europython.eu/media/conference/slides/less-known-packaging-features-and-tricks.pdf
https://realpython.com/documenting-python-code/#public-and-open-source-projects
"""
import os
import re
import sys
import pkg_resources
# numpy.distutils will figure out if setuptools is available when imported
# this allows us to combine setuptools and f2py extensions
import setuptools
from setuptools import Command
from numpy.distutils.core import setup
from numpy.distutils.misc_util import Configuration
from distutils.command.sdist import sdist
ROOT = os.path.abspath(os.path.dirname(__file__))
PACKAGE_NAME = 'wafo'
def read(file_path, lines=False):
"""Returns contents of file either as a string or list of lines."""
with open(file_path, 'r') as fp:
if lines:
return fp.readlines()
return fp.read()
def find_version(file_path):
"""Returns version given in the __version__ variable of a module file"""
version_file = read(file_path)
version_match = re.search(r"^__version__ = ['\"]([^'\"]*)['\"]",
version_file, re.M) # @UndefinedVariable
if version_match:
return version_match.group(1)
raise RuntimeError("Unable to find version string.")
class Doctest(Command):
description = 'Run doctests with Sphinx'
user_options = []
def initialize_options(self):
pass
def finalize_options(self):
pass
def run(self):
from sphinx.application import Sphinx
sph = Sphinx('./docs', # source directory
'./docs', # directory containing conf.py
'./docs/_build', # output directory
'./docs/_build/doctrees', # doctree directory
'doctest') # finally, specify the doctest builder
sph.build()
class Latex(Command):
description = 'Run latex with Sphinx'
user_options = []
def initialize_options(self):
pass
def finalize_options(self):
pass
def run(self):
from sphinx.application import Sphinx
sph = Sphinx('./docs', # source directory
'./docs', # directory containing conf.py
'./docs/_build/latex', # output directory
'./docs/_build/doctrees', # doctree directory
'latex') # finally, specify the latex builder
sph.build()
def setup_package():
extra_link_args = ["-static", "-static-libgfortran", "-static-libgcc"] if os.name == 'nt' else []
config = Configuration(PACKAGE_NAME)
# -------------------------------------------------------------------------
# c_library
config.add_extension('c_library',
sources=['source/c_library/c_library.pyf',
'source/c_library/c_functions.c'])
# -------------------------------------------------------------------------
# mvn
config.add_extension('mvn',
sources=['source/mvn/mvn.pyf',
'source/mvn/mvndst.f'],
extra_link_args=extra_link_args)
# -------------------------------------------------------------------------
# mvnprdmod
lib_mvnprdmod_src = ['source/mvnprd/mvnprd.f',
'source/mvnprd/mvnprodcorrprb.f']
config.add_library('_mvnprdmod', sources=lib_mvnprdmod_src)
config.add_extension('mvnprdmod',
sources=['source/mvnprd/mvnprd_interface.f'],
libraries=['_mvnprdmod'],
depends=(lib_mvnprdmod_src),
extra_link_args=extra_link_args)
# -------------------------------------------------------------------------
# cov2mod
lib_cov2mod_src = ['source/mreg/dsvdc.f',
'source/mreg/mregmodule.f',
'source/mreg/intfcmod.f']
config.add_library('_cov2mod', sources=lib_cov2mod_src)
config.add_extension('cov2mod',
sources=['source/mreg/cov2mmpdfreg_intfc.f'],
libraries=['_cov2mod'],
include_dirs=['source/mreg/'],
depends=(lib_cov2mod_src),
extra_link_args=extra_link_args)
# -------------------------------------------------------------------------
# rindmod
lib_rindmod_src = ['source/rind2007/intmodule.f',
'source/rind2007/jacobmod.f',
'source/rind2007/swapmod.f',
'source/rind2007/fimod.f',
'source/rind2007/rindmod.f',
'source/rind2007/rind71mod.f']
config.add_library('_rindmod', sources=lib_rindmod_src)
config.add_extension('rindmod',
sources=['source/rind2007/rind_interface.f'],
libraries=['_rindmod'],
include_dirs=['source/mreg/'],
depends=(lib_rindmod_src),
extra_link_args=extra_link_args)
config.add_data_dir(('data', 'src/wafo/data'))
version = find_version(os.path.join(ROOT, 'src', PACKAGE_NAME, "__init__.py"))
print("Version: {}".format(version))
sphinx_requires = ['sphinx>=1.3.1']
needs_sphinx = {'build_sphinx', 'upload_docs'}.intersection(sys.argv)
sphinx = ['numpydoc',
'imgmath',
'sphinx_rtd_theme>=0.1.7'] + sphinx_requires if needs_sphinx else []
setup(
version=version,
install_requires=read(os.path.join(ROOT, 'requirements.txt'), lines=True),
extras_require={'build_sphinx': sphinx_requires},
setup_requires=["pytest-runner"] + sphinx,
package_data={ # If any package contains *.txt or *.rst files, include them:
"": ["*.dat"],},
cmdclass={'doctest': Doctest,
'latex': Latex,
'sdist': sdist},
**config.todict()
)
if __name__ == "__main__":
setup_package()