setup.py
#!/usr/bin/env python
import os
import re
from pathlib import Path
from setuptools import Extension
from setuptools import find_packages
from setuptools import setup
from setuptools.command.build_ext import build_ext
from setuptools.dist import Distribution
try:
# Allow installing package without any Cython available. This
# assumes you are going to include the .c files in your sdist.
import Cython
except ImportError:
Cython = None
# Enable code coverage for C code: we cannot use CFLAGS=-coverage in tox.ini, since that may mess with compiling
# dependencies (e.g. numpy). Therefore, we set SETUPPY_CFLAGS=-coverage in tox.ini and copy it to CFLAGS here (after
# deps have been safely installed).
if "TOX_ENV_NAME" in os.environ and os.environ.get("SETUPPY_EXT_COVERAGE") == "yes":
CFLAGS = os.environ["CFLAGS"] = "-DCYTHON_TRACE=1"
LFLAGS = os.environ["LFLAGS"] = ""
else:
CFLAGS = ""
LFLAGS = ""
class OptionalBuildExt(build_ext):
"""
Allow the building of C extensions to fail.
"""
def run(self):
try:
if os.environ.get("SETUPPY_FORCE_PURE"):
raise Exception("C extensions disabled (SETUPPY_FORCE_PURE)!")
super().run()
except Exception as e:
self._unavailable(e)
self.extensions = [] # avoid copying missing files (it would fail).
def _unavailable(self, e):
print("*" * 80)
print(
"""WARNING:
An optional code optimization (C extension) could not be compiled.
Optimizations for this package will not be available!
"""
)
print("CAUSE:")
print("")
print(" " + repr(e))
print("*" * 80)
class BinaryDistribution(Distribution):
"""
Distribution which almost always forces a binary package with platform name
"""
def has_ext_modules(self):
return super().has_ext_modules() or not os.environ.get("SETUPPY_ALLOW_PURE")
def read(*names, **kwargs):
with Path(__file__).parent.joinpath(*names).open(encoding=kwargs.get("encoding", "utf8")) as fh:
return fh.read()
setup(
name="nameless",
use_scm_version={
"local_scheme": "dirty-tag",
"write_to": "src/nameless/_version.py",
"fallback_version": "1.0.0",
},
license="BSD-2-Clause",
description="An example package. Generated with cookiecutter-pylibrary.",
long_description="{}\n{}".format(
re.compile("^.. start-badges.*^.. end-badges", re.M | re.S).sub("", read("README.rst")),
re.sub(":[a-z]+:`~?(.*?)`", r"``\1``", read("CHANGELOG.rst")),
),
author="Ionel Cristian Mărieș",
author_email="contact@ionelmc.ro",
url="https://github.com/ionelmc/python-nameless",
packages=find_packages("src"),
package_dir={"": "src"},
py_modules=[path.stem for path in Path("src").glob("*.py")],
include_package_data=True,
zip_safe=False,
classifiers=[
# complete classifier list: http://pypi.python.org/pypi?%3Aaction=list_classifiers
"Development Status :: 5 - Production/Stable",
"Intended Audience :: Developers",
"License :: OSI Approved :: BSD License",
"Operating System :: Unix",
"Operating System :: POSIX",
"Operating System :: Microsoft :: Windows",
"Programming Language :: Python",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3 :: Only",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: Implementation :: CPython",
"Programming Language :: Python :: Implementation :: PyPy",
# uncomment if you test on these interpreters:
# "Programming Language :: Python :: Implementation :: IronPython",
# "Programming Language :: Python :: Implementation :: Jython",
# "Programming Language :: Python :: Implementation :: Stackless",
"Topic :: Utilities",
],
project_urls={
"Documentation": "https://python-nameless.readthedocs.io/",
"Changelog": "https://python-nameless.readthedocs.io/en/latest/changelog.html",
"Issue Tracker": "https://github.com/ionelmc/python-nameless/issues",
},
keywords=[
# eg: "keyword1", "keyword2", "keyword3",
],
python_requires=">=3.8",
install_requires=[
# eg: "aspectlib==1.1.1", "six>=1.7",
],
extras_require={
# eg:
# "rst": ["docutils>=0.11"],
# ":python_version=="2.6"": ["argparse"],
},
setup_requires=(
[
"setuptools_scm>=3.3.1",
"cython",
]
if Cython
else [
"setuptools_scm>=3.3.1",
]
),
entry_points={
"console_scripts": [
"nameless = nameless.cli:run",
]
},
cmdclass={"build_ext": OptionalBuildExt},
ext_modules=[
Extension(
str(path.relative_to("src").with_suffix("")).replace(os.sep, "."),
sources=[str(path)],
extra_compile_args=CFLAGS.split(),
extra_link_args=LFLAGS.split(),
include_dirs=[str(path.parent)],
)
for path in Path("src").glob("**/*.pyx" if Cython else "**/*.c")
],
distclass=BinaryDistribution,
)