-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathsetup.py
208 lines (175 loc) · 8.55 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
"""A setuptools based setup module.
See:
https://packaging.python.org/en/latest/distributing.html
https://github.com/pypa/sampleproject
"""
from os import path
from setuptools import setup, find_packages
here = path.abspath(path.dirname(__file__))
# *************** Dependencies *********
INSTALL_REQUIRES = ['typing_inspect', 'pytypes']
DEPENDENCY_LINKS = []
SETUP_REQUIRES = ['pytest-runner', 'setuptools_scm', 'pypandoc', 'pandoc', 'docutils']
TESTS_REQUIRE = ['pytest', 'pytest-logging', 'pytest-cov', 'numpy', 'pandas', 'jprops', 'pyyaml', 'xlrd', 'autoclass',
'pycontracts', 'attrs', 'enforce', 'valid8']
EXTRAS_REQUIRE = {'xls_parser': ['xlrd'],
'numpy_parser': ['numpy'],
'pandas_parser': ['numpy', 'pandas'],
'jprops_parser': ['jprops'],
'yaml_parser': ['pyyaml'],
'autoclass': ['autoclass']}
# simple check
try:
from setuptools_scm import get_version
except Exception as e:
raise Exception('Required packages for setup not found. You may wish you execute '
'"pip install -r ci_tools/requirements-setup.txt" to install them or alternatively install them '
'manually using conda or other system. The list is : ' + str(SETUP_REQUIRES)) from e
# ************** ID card *****************
DISTNAME = 'parsyfiles'
DESCRIPTION = 'Combines most popular python parsers (json, jprops, pickle...) with user-defined parsers and type ' \
'converters to read objects from files. Supports multifile & multiparser objects, typically useful to ' \
'organize test data. Leverages PEP484 type hints in order to intelligently use the best parser/converter'\
' chain, and to try several combinations if relevant'
MAINTAINER = 'Sylvain Marié'
MAINTAINER_EMAIL = 'sylvain.marie@schneider-electric.com'
URL = 'https://github.com/smarie/parsyfiles'
LICENSE = 'BSD 3-Clause'
LICENSE_LONG = 'License :: OSI Approved :: BSD License'
version_for_download_url = get_version()
DOWNLOAD_URL = URL + '/tarball/' + version_for_download_url
KEYWORDS = 'parsing framework file converter conversion parser object folder dict yaml properties' \
'collection complex simple benchmark type class PEP484 type-hint data binding'
# --Get the long description from the README file
# with open(path.join(here, 'README.md'), encoding='utf-8') as f:
# LONG_DESCRIPTION = f.read()
try:
import pypandoc
LONG_DESCRIPTION = pypandoc.convert(path.join(here, 'README.md'), 'rst').replace('\r', '')
# Validate that the generated doc is correct
from docutils.parsers.rst import Parser
from docutils.utils import new_document
from docutils.frontend import OptionParser
# import pygments
settings = OptionParser(components=(Parser,)).get_default_values()
document = new_document('(generated) DESCRIPTION.rst', settings=settings)
from distutils.command.check import SilentReporter
reporter = SilentReporter('(generated) DESCRIPTION.rst',
settings.report_level,
settings.halt_level,
stream=settings.warning_stream,
debug=settings.debug,
encoding=settings.error_encoding,
error_handler=settings.error_encoding_error_handler)
document.reporter = reporter
parser = Parser()
parser.parse(LONG_DESCRIPTION, document)
from warnings import warn
if len(reporter.messages) > 0:
# display all errors
for warning in reporter.messages:
line = warning[-1].get('line')
if line is None:
warning = warning[1]
else:
warning = '%s (line %s)' % (warning[1], line)
warn(warning)
# dump the created file so that one can have a look
with open('GENERATED_DESCRIPTION_TO_DELETE.rst', 'wb') as f:
f.write(LONG_DESCRIPTION.encode('utf-8'))
print('There are warnings in the generated DESCRIPTION.rst. The created description file has been dumped to '
'GENERATED_DESCRIPTION_TO_DELETE.rst temporary file for review')
input("Press Enter to continue...")
except(ImportError):
from warnings import warn
warn('WARNING pypandoc and/or docutils could not be imported - we recommend that you install them in order to '
'package the documentation correctly')
LONG_DESCRIPTION = open('README.md').read()
# ************* VERSION **************
# --Get the Version number from VERSION file, see https://packaging.python.org/single_source_version/ option 4.
# THIS IS DEPRECATED AS WE NOW USE GIT TO MANAGE VERSION
# with open(path.join(here, 'VERSION')) as version_file:
# VERSION = version_file.read().strip()
OBSOLETES = ['sficopaf']
setup(
name=DISTNAME,
description=DESCRIPTION,
long_description=LONG_DESCRIPTION,
# Versions should comply with PEP440. For a discussion on single-sourcing
# the version across setup.py and the project code, see
# https://packaging.python.org/en/latest/single_source_version.html
# version=VERSION, NOW HANDLED BY GIT
maintainer=MAINTAINER,
maintainer_email=MAINTAINER_EMAIL,
license=LICENSE,
url=URL,
download_url=DOWNLOAD_URL,
# See https://pypi.python.org/pypi?%3Aaction=list_classifiers
classifiers=[
# How mature is this project? Common values are
# 3 - Alpha
# 4 - Beta
# 5 - Production/Stable
'Development Status :: 5 - Production/Stable',
# Indicate who your project is intended for
'Intended Audience :: Developers',
'Topic :: Software Development :: Libraries :: Python Modules',
# Pick your license as you wish (should match "license" above)
LICENSE_LONG,
# Specify the Python versions you support here. In particular, ensure
# that you indicate whether you support Python 2, Python 3 or both.
#'Programming Language :: Python :: 2',
#'Programming Language :: Python :: 2.6',
#'Programming Language :: Python :: 2.7',
#'Programming Language :: Python :: 3',
#'Programming Language :: Python :: 3.3',
#'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5',
],
# What does your project relate to?
keywords=KEYWORDS,
# You can just specify the packages manually here if your project is
# simple. Or you can use find_packages().
packages=find_packages(exclude=['contrib', 'docs', 'tests', 'test-data']), #['parsyfiles'],
# Alternatively, if you want to distribute just a my_module.py, uncomment
# this:
# py_modules=["my_module"],
# List run-time dependencies here. These will be installed by pip when
# your project is installed. For an analysis of "install_requires" vs pip's
# requirements files see:
# https://packaging.python.org/en/latest/requirements.html
install_requires=INSTALL_REQUIRES,
dependency_links=DEPENDENCY_LINKS,
# we're using git
use_scm_version=True, # this provides the version + adds the date if local non-commited changes.
#use_scm_version={'local_scheme':'dirty-tag'}, # this provides the version + adds '+dirty' if local non-commited changes.
setup_requires=SETUP_REQUIRES,
# test
test_suite='nose.collector',
tests_require=TESTS_REQUIRE,
# List additional groups of dependencies here (e.g. development
# dependencies). You can install these using the following syntax,
# for example:
# $ pip install -e .[dev,test]
extras_require=EXTRAS_REQUIRE,
obsoletes=OBSOLETES,
# If there are data files included in your packages that need to be
# installed, specify them here. If using Python 2.6 or less, then these
# have to be included in MANIFEST.in as well.
# package_data={
# 'sample': ['package_data.dat'],
# },
# Although 'package_data' is the preferred approach, in some case you may
# need to place data files outside of your packages. See:
# http://docs.python.org/3.4/distutils/setupscript.html#installing-additional-files # noqa
# In this case, 'data_file' will be installed into '<sys.prefix>/my_data'
# data_files=[('my_data', ['data/data_file'])],
# To provide executable scripts, use entry points in preference to the
# "scripts" keyword. Entry points provide cross-platform support and allow
# pip to create the appropriate form of executable for the target platform.
# entry_points={
# 'console_scripts': [
# 'sample=sample:main',
# ],
# },
)