Skip to content

Commit

Permalink
Merge pull request #3 from theleagueof/make-it-a-program
Browse files Browse the repository at this point in the history
  • Loading branch information
alerque authored Apr 15, 2020
2 parents 4d68d06 + d46a29d commit 4cbb5ee
Show file tree
Hide file tree
Showing 10 changed files with 374 additions and 0 deletions.
15 changes: 15 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
root = true

[*]
end_of_line = lf
insert_final_newline = true
charset = utf-8
trim_trailing_whitespace = true

[{*.py,fontship.in}]
indent_style = space
indent_size = 4

[makefile*]
indent_style = tab
indent_size = 4
47 changes: 47 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
### Generated files ###

fontship

### Editor cruft ###

tags

### Autotools ###
# http://www.gnu.org/software/automake

Makefile
Makefile.in
/ar-lib
/mdate-sh
/py-compile
/test-driver
/ylwrap

# http://www.gnu.org/software/autoconf

autom4te.cache
/autoscan.log
/autoscan-*.log
/aclocal.m4
/compile
/config.guess
/config.h.in
/config.log
/config.status
/config.sub
/configure
/configure.scan
/depcomp
/install-sh
/missing
/stamp-h1

### Python ###
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# Installer logs
pip-log.txt
pip-delete-this-directory.txt
8 changes: 8 additions & 0 deletions Makefile.am
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
bin_SCRIPTS = fontship
python_PYTHON = fontship.py
dist_doc_DATA = README.md
license_DATA = LICENSE

licensedir = $(datadir)/licenses/fontship

CLEANFILES = $(bin_SCRIPTS)
52 changes: 52 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,55 @@

A font development toolkit and collaborative work flow developed by [The
League of Moveable Type](https://www.theleagueofmoveabletype.com/).

## Setup & Usage

Fontship can be used in any of three different ways:

1. Directly on a local system that has all the required dependencies.
2. On a local system via a Docker image for low hastle setup.
3. Remotely via a CI runner.

### Local Setup

To install and use locally, you'll need some dependencies:

* Git
* Python 3
* GNU Make 4.2 & automake
* GNU core utilities (tar, touch, sed, etc.)
* BSD tar
* Assorted python modules see `requirements.txt`.

Install the software to your computer. Either clone this repository and
run `./bootstrap.sh` or download and extract a tarball, then run:

$ ./configure
$ make
$ sudo make install

### Docker Setup

Add an alias:

$ alias fontship='docker run -it --volume "$(pwd):/data" --user "$(id -u):$(id -g)" theleagueof/fontship:master"

### CI Setup

Add a Github Actions configuration file to your repository such as
`.github/workflow/fontship.yml`:

``` yaml
name: Fontship
on: [push, pull_request]
jobs:
fontship:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@master
- name: Fontship
uses: theleagueof/fontship@master
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
2 changes: 2 additions & 0 deletions bootstrap.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
#/usr/bin/env sh
autoreconf --install -W none
219 changes: 219 additions & 0 deletions build-aux/git-version-gen
Original file line number Diff line number Diff line change
@@ -0,0 +1,219 @@
#!/bin/sh
# Print a version string.
scriptversion=2012-03-18.17; # UTC

# Copyright (C) 2007-2012 Free Software Foundation, Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.

# This script is derived from GIT-VERSION-GEN from GIT: http://git.or.cz/.
# It may be run two ways:
# - from a git repository in which the "git describe" command below
# produces useful output (thus requiring at least one signed tag)
# - from a non-git-repo directory containing a .tarball-version file, which
# presumes this script is invoked like "./git-version-gen .tarball-version".

# In order to use intra-version strings in your project, you will need two
# separate generated version string files:
#
# .tarball-version - present only in a distribution tarball, and not in
# a checked-out repository. Created with contents that were learned at
# the last time autoconf was run, and used by git-version-gen. Must not
# be present in either $(srcdir) or $(builddir) for git-version-gen to
# give accurate answers during normal development with a checked out tree,
# but must be present in a tarball when there is no version control system.
# Therefore, it cannot be used in any dependencies. GNUmakefile has
# hooks to force a reconfigure at distribution time to get the value
# correct, without penalizing normal development with extra reconfigures.
#
# .version - present in a checked-out repository and in a distribution
# tarball. Usable in dependencies, particularly for files that don't
# want to depend on config.h but do want to track version changes.
# Delete this file prior to any autoconf run where you want to rebuild
# files to pick up a version string change; and leave it stale to
# minimize rebuild time after unrelated changes to configure sources.
#
# As with any generated file in a VC'd directory, you should add
# /.version to .gitignore, so that you don't accidentally commit it.
# .tarball-version is never generated in a VC'd directory, so needn't
# be listed there.
#
# Use the following line in your configure.ac, so that $(VERSION) will
# automatically be up-to-date each time configure is run (and note that
# since configure.ac no longer includes a version string, Makefile rules
# should not depend on configure.ac for version updates).
#
# AC_INIT([GNU project],
# m4_esyscmd([build-aux/git-version-gen .tarball-version]),
# [bug-project@example])
#
# Then use the following lines in your Makefile.am, so that .version
# will be present for dependencies, and so that .version and
# .tarball-version will exist in distribution tarballs.
#
# EXTRA_DIST = $(top_srcdir)/.version
# BUILT_SOURCES = $(top_srcdir)/.version
# $(top_srcdir)/.version:
# echo $(VERSION) > $@-t && mv $@-t $@
# dist-hook:
# echo $(VERSION) > $(distdir)/.tarball-version


me=$0

version="git-version-gen $scriptversion
Copyright 2011 Free Software Foundation, Inc.
There is NO warranty. You may redistribute this software
under the terms of the GNU General Public License.
For more information about these matters, see the files named COPYING."

usage="\
Usage: $me [OPTION]... \$srcdir/.tarball-version [TAG-NORMALIZATION-SED-SCRIPT]
Print a version string.
Options:
--prefix prefix of git tags (default 'v')
--help display this help and exit
--version output version information and exit
Running without arguments will suffice in most cases."

prefix=v

while test $# -gt 0; do
case $1 in
--help) echo "$usage"; exit 0;;
--version) echo "$version"; exit 0;;
--prefix) shift; prefix="$1";;
-*)
echo "$0: Unknown option '$1'." >&2
echo "$0: Try '--help' for more information." >&2
exit 1;;
*)
if test -z "$tarball_version_file"; then
tarball_version_file="$1"
elif test -z "$tag_sed_script"; then
tag_sed_script="$1"
else
echo "$0: extra non-option argument '$1'." >&2
exit 1
fi;;
esac
shift
done

if test -z "$tarball_version_file"; then
echo "$usage"
exit 1
fi

tag_sed_script="${tag_sed_script:-s/x/x/}"

nl='
'

# Avoid meddling by environment variable of the same name.
v=
v_from_git=

# First see if there is a tarball-only version file.
# then try "git describe", then default.
if test -f $tarball_version_file
then
v=`cat $tarball_version_file` || v=
case $v in
*$nl*) v= ;; # reject multi-line output
[0-9]*) ;;
*) v= ;;
esac
test -z "$v" \
&& echo "$0: WARNING: $tarball_version_file is missing or damaged" 1>&2
fi

if test -n "$v"
then
: # use $v
# Otherwise, if there is at least one git commit involving the working
# directory, and "git describe" output looks sensible, use that to
# derive a version string.
elif test "`git log -1 --pretty=format:x . 2>/dev/null`" = x \
&& v=`git describe --tags --abbrev=7 --match="$prefix*" HEAD 2>/dev/null \
|| git describe --tags --abbrev=7 HEAD 2>/dev/null \
|| git log -1 --pretty=format:'v0-HEAD-%h' 2>/dev/null` \
&& v=`printf '%s\n' "$v" | sed "$tag_sed_script"` \
&& case $v in
$prefix[0-9]*) ;;
*) (exit 1) ;;
esac
then
# Is this a new git that lists number of commits since the last
# tag or the previous older version that did not?
# Newer: v6.10-77-g0f8faeb
# Older: v6.10-g0f8faeb
case $v in
*-*-*) : git describe is okay three part flavor ;;
*-*)
: git describe is older two part flavor
# Recreate the number of commits and rewrite such that the
# result is the same as if we were using the newer version
# of git describe.
vtag=`echo "$v" | sed 's/-.*//'`
commit_list=`git rev-list "$vtag"..HEAD 2>/dev/null` \
|| { commit_list=failed;
echo "$0: WARNING: git rev-list failed" 1>&2; }
numcommits=`echo "$commit_list" | wc -l`
v=`echo "$v" | sed "s/\(.*\)-\(.*\)/\1-$numcommits-\2/"`;
test "$commit_list" = failed && v=UNKNOWN
;;
esac

v=`echo "$v" | sed 's/-/.r/'`;
v_from_git=1
else
v=UNKNOWN
fi

v=`echo "$v" |sed "s/^$prefix//"`

# Test whether to append the "-dirty" suffix only if the version
# string we're using came from git. I.e., skip the test if it's "UNKNOWN"
# or if it came from .tarball-version.
if test -n "$v_from_git"; then
# Don't declare a version "dirty" merely because a time stamp has changed.
git update-index --refresh > /dev/null 2>&1

dirty=`exec 2>/dev/null;git diff-index --name-only HEAD` || dirty=
case "$dirty" in
'') ;;
*) # Append the suffix only if there isn't one already.
case $v in
*-dirty) ;;
*) v="$v-dirty" ;;
esac ;;
esac
fi

# Omit the trailing newline, so that m4_esyscmd can use the result directly.
echo "$v" | tr -d "$nl"

# Local variables:
# eval: (add-hook 'write-file-hooks 'time-stamp)
# time-stamp-start: "scriptversion="
# time-stamp-format: "%:y-%02m-%02d.%02H"
# time-stamp-time-zone: "UTC"
# time-stamp-end: "; # UTC"
# End:
12 changes: 12 additions & 0 deletions configure.ac
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
AC_INIT([fontship],
m4_esyscmd([build-aux/git-version-gen .tarball-version]),
[[email protected]])
AM_INIT_AUTOMAKE([foreign dist-zip])
AM_SILENT_RULES([yes])

AM_PATH_PYTHON([3.6])

AC_CONFIG_FILES([Makefile])
AC_CONFIG_FILES([fontship], [chmod +x fontship])

AC_OUTPUT
7 changes: 7 additions & 0 deletions fontship.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
#!/usr/bin/env @PYTHON@

VERSION = "@VERSION@"

import fontship

# vim: ft=python
1 change: 1 addition & 0 deletions fontship.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
print("Thing")
11 changes: 11 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
#afdko==3.2.1
#fonttools[ufo,lxml]==4.6.0
#psautohint==2.0.1
#fontmake==2.1.0
#defcon==0.6.0
#ufo2ft==2.13.0
#ufoLib2==0.6.2
#font-v==1.0.2
#pcpp==1.21
#skia-pathops==0.2.1
#git+git://github.com/alif-type/[email protected]#egg=sfdLib

0 comments on commit 4cbb5ee

Please sign in to comment.