blob: 30826a746b7c7ccd98bcfceadf511fc54d61cfde [file] [log] [blame]
#! /usr/bin/env python
from __future__ import print_function
import io
import sys
import os
from os.path import isfile, join as pjoin
from glob import glob
from setuptools import setup, find_packages, Command
from distutils import log
from distutils.util import convert_path
import subprocess as sp
import contextlib
import re
# Force distutils to use py_compile.compile() function with 'doraise' argument
# set to True, in order to raise an exception on compilation errors
import py_compile
orig_py_compile = py_compile.compile
def doraise_py_compile(file, cfile=None, dfile=None, doraise=False):
orig_py_compile(file, cfile=cfile, dfile=dfile, doraise=True)
py_compile.compile = doraise_py_compile
needs_pytest = {'pytest', 'test'}.intersection(sys.argv)
pytest_runner = ['pytest_runner'] if needs_pytest else []
needs_wheel = {'bdist_wheel'}.intersection(sys.argv)
wheel = ['wheel'] if needs_wheel else []
needs_bumpversion = {'release'}.intersection(sys.argv)
bumpversion = ['bump2version'] if needs_bumpversion else []
# Trove classifiers for PyPI
classifiers = {"classifiers": [
"Development Status :: 5 - Production/Stable",
"Environment :: Console",
"Environment :: Other Environment",
"Intended Audience :: Developers",
"Intended Audience :: End Users/Desktop",
"License :: OSI Approved :: BSD License",
"Natural Language :: English",
"Operating System :: OS Independent",
"Programming Language :: Python",
"Programming Language :: Python :: 2",
"Programming Language :: Python :: 3",
"Topic :: Text Processing :: Fonts",
"Topic :: Multimedia :: Graphics",
"Topic :: Multimedia :: Graphics :: Graphics Conversion",
# concatenate README.rst and into long_description so they are
# displayed on the FontTols project page on PyPI
with"README.rst", "r", encoding="utf-8") as readme:
long_description =
long_description += "\nChangelog\n~~~~~~~~~\n\n"
with"NEWS.rst", "r", encoding="utf-8") as changelog:
long_description +=
def capture_logger(name):
""" Context manager to capture a logger output with a StringIO stream.
import logging
logger = logging.getLogger(name)
import StringIO
stream = StringIO.StringIO()
except ImportError:
stream = io.StringIO()
handler = logging.StreamHandler(stream)
yield stream
class release(Command):
Tag a new release with a single command, using the 'bumpversion' tool
to update all the version strings in the source code.
The version scheme conforms to 'SemVer' and PEP 440 specifications.
Firstly, the pre-release '.devN' suffix is dropped to signal that this is
a stable release. If '--major' or '--minor' options are passed, the
the first or second 'semver' digit is also incremented. Major is usually
for backward-incompatible API changes, while minor is used when adding
new backward-compatible functionalities. No options imply 'patch' or bug-fix
A new header is also added to the changelog file ("NEWS.rst"), containing
the new version string and the current 'YYYY-MM-DD' date.
All changes are committed, and an annotated git tag is generated. With the
--sign option, the tag is GPG-signed with the user's default key.
Finally, the 'patch' part of the version string is bumped again, and a
pre-release suffix '.dev0' is appended to mark the opening of a new
development cycle.
description = "update version strings for release"
user_options = [
("major", None, "bump the first digit (incompatible API changes)"),
("minor", None, "bump the second digit (new backward-compatible features)"),
("sign", "s", "make a GPG-signed tag, using the default key"),
("allow-dirty", None, "don't abort if working directory is dirty"),
changelog_name = "NEWS.rst"
version_RE = re.compile("^[0-9]+\.[0-9]+")
date_fmt = u"%Y-%m-%d"
header_fmt = u"%s (released %s)"
commit_message = "Release {new_version}"
tag_name = "{new_version}"
version_files = [
def initialize_options(self):
self.minor = False
self.major = False
self.sign = False
self.allow_dirty = False
def finalize_options(self):
if all([self.major, self.minor]):
from distutils.errors import DistutilsOptionError
raise DistutilsOptionError("--major/--minor are mutually exclusive")
self.part = "major" if self.major else "minor" if self.minor else None
def run(self):
if self.part is not None:"bumping '%s' version" % self.part)
self.bumpversion(self.part, commit=False)
release_version = self.bumpversion(
"release", commit=False, allow_dirty=True)
else:"stripping pre-release suffix")
release_version = self.bumpversion("release")" version = %s" % release_version)
changes = self.format_changelog(release_version)
self.git_tag(release_version, changes, self.sign)"bumping 'patch' version and pre-release suffix")
next_dev_version = self.bumpversion('patch', commit=True)" version = %s" % next_dev_version)
def git_commit(self, version):
""" Stage and commit all relevant version files, and format the commit
message with specified 'version' string.
files = self.version_files + [self.changelog_name]"committing changes")
for f in files:" %s" % f)
if self.dry_run:
sp.check_call(["git", "add"] + files)
msg = self.commit_message.format(new_version=version)
sp.check_call(["git", "commit", "-m", msg], stdout=sp.PIPE)
def git_tag(self, version, message, sign=False):
""" Create annotated git tag with given 'version' and 'message'.
Optionally 'sign' the tag with the user's GPG key.
""""creating %s git tag '%s'" % (
"signed" if sign else "annotated", version))
if self.dry_run:
# create an annotated (or signed) tag from the new version
tag_opt = "-s" if sign else "-a"
tag_name = self.tag_name.format(new_version=version)
proc = sp.Popen(
["git", "tag", tag_opt, "-F", "-", tag_name], stdin=sp.PIPE)
# use the latest changes from the changelog file as the tag message
tag_message = u"%s\n\n%s" % (tag_name, message)
if proc.returncode != 0:
def bumpversion(self, part, commit=False, message=None, allow_dirty=None):
""" Run bumpversion.main() with the specified arguments, and return the
new computed version string (cf. 'bumpversion --help' for more info)
import bumpversion
args = (
(['--verbose'] if self.verbose > 1 else []) +
(['--dry-run'] if self.dry_run else []) +
(['--allow-dirty'] if (allow_dirty or self.allow_dirty) else []) +
(['--commit'] if commit else ['--no-commit']) +
(['--message', message] if message is not None else []) +
['--list', part]
log.debug("$ bumpversion %s" % " ".join(a.replace(" ", "\\ ") for a in args))
with capture_logger("bumpversion.list") as out:
last_line = out.getvalue().splitlines()[-1]
new_version = last_line.replace("new_version=", "")
return new_version
def format_changelog(self, version):
""" Write new header at beginning of changelog file with the specified
'version' and the current date.
Return the changelog content for the current release.
from datetime import datetime"formatting changelog")
changes = []
with, "r+", encoding="utf-8") as f:
for ln in f:
if self.version_RE.match(ln):
if not self.dry_run:
content =
date =
header = self.header_fmt % (version, date)
f.write(header + u"\n" + u"-"*len(header) + u"\n\n" + content)
return u"".join(changes)
class PassCommand(Command):
""" This is used with Travis `dpl` tool so that it skips creating sdist
and wheel packages, but simply uploads to PyPI the files found in ./dist
folder, that were previously built inside the tox 'bdist' environment.
This ensures that the same files are uploaded to Github Releases and PyPI.
description = "do nothing"
user_options = []
def initialize_options(self):
def finalize_options(self):
def run(self):
def find_data_files(manpath="share/man"):
""" Find FontTools's data_files (just man pages at this point).
By default, we install man pages to "share/man" directory relative to the
base installation directory for data_files. The latter can be changed with
the --install-data option of ' install' sub-command.
E.g., if the data files installation directory is "/usr", the default man
page installation directory will be "/usr/share/man".
You can override this via the $FONTTOOLS_MANPATH environment variable.
E.g., on some BSD systems man pages are installed to 'man' instead of
'share/man'; you can export $FONTTOOLS_MANPATH variable just before
$ FONTTOOLS_MANPATH="man" pip install -v .
running install_data
copying Doc/man/ttx.1 -> /usr/man/man1
When installing from PyPI, for this variable to have effect you need to
force pip to install from the source distribution instead of the wheel
package (otherwise is not run), by using the --no-binary option:
$ FONTTOOLS_MANPATH="man" pip install --no-binary=fonttools fonttools
Note that you can only override the base man path, i.e. without the
section number (man1, man3, etc.). The latter is always implied to be 1,
for "general commands".
# get base installation directory for man pages
manpagebase = os.environ.get('FONTTOOLS_MANPATH', convert_path(manpath))
# all our man pages go to section 1
manpagedir = pjoin(manpagebase, 'man1')
manpages = [f for f in glob(pjoin('Doc', 'man', 'man1', '*.1')) if isfile(f)]
data_files = [(manpagedir, manpages)]
return data_files
description="Tools to manipulate font files",
author="Just van Rossum",
maintainer="Behdad Esfahbod",
license="OpenSource, BSD-style",
package_dir={'': 'Lib'},
setup_requires=pytest_runner + wheel + bumpversion,
'console_scripts': [
"fonttools = fontTools.__main__:main",
"ttx = fontTools.ttx:main",
"pyftsubset = fontTools.subset:main",
"pyftmerge = fontTools.merge:main",
"pyftinspect = fontTools.inspect:main"
"release": release,
'pass': PassCommand,