Skip to main content

Font analysis tool for determining character/glyph support

Project description

Latest PyPI Version Python Travis Build Status License: GPL v3

pyfontaine analyses fonts for their language and character/glyph-set support.

It has a straightforward pythonic set definition format:

Additional definitions are downloaded from the Extensis, font-config and Unicode websites during installation, and can be updated without reinstalling.

Adding your own definitions is easy. All files in the internals directory are auto-detected, so just add definition files there.

Installation

First, install Python and the pip python package manager. This is installed by default with homebrew python, so, install homebrew, then install pip as follows:

brew install python;
brew install icu4c;

On Mac OS X, install the pyicu dependency as follows:

CFLAGS=-I/usr/local/opt/icu4c/include LDFLAGS=-L/usr/local/opt/icu4c/lib pip install pyicu;

Install the latest release easily with pip:

sudo pip install fontaine

To install the latest development version:

sudo pip install https://github.com/googlefonts/pyfontaine/archive/master.zip;

Usage

Given a list of space separated font filenames, it returns a report with some general metadata and a language support analysis:

pyfontaine font.ttf;

Given a list of space separated unicode characters, or unicode values, it returns a list of character sets that include that character:

pyfontaine 0x0061;
pyfontaine ğ ø ∂;

Similarly you can find out if a font supports specific characters by also giving the filename:

pyfontaine U+C480 U+C481 font.ttf;

To output font reports in various formats:

pyfontaine --xml font.ttf;
pyfontaine --json font.ttf;
pyfontaine --csv font.ttf;
pyfontaine --wiki font.ttf;

The –wiki format produces a MediaWiki table (example)

To only show character sets from different collections:

pyfontaine --collections all font.ttf; # default
pyfontaine --collections pyfontaine font.ttf;
pyfontaine --collections uniblocks font.ttf;
pyfontaine --collections extensis font.ttf;
pyfontaine --collections fontconfig font.ttf;
pyfontaine --collections cldr font.ttf;
pyfontaine --collections subsets font.ttf;

To only show specific character sets:

pyfontaine --set africaan,adobe_latin_3 font.ttf;

To print a list of all the missing unicode values from each set:

   pyfontaine --missing --set adobe_latin_3 font.ttf;

To output visualisations of the coverage using `Hilbert curves <http://en.wikipedia.org/wiki/Hilbert_curve>`__ (thanks for the idea, `Øyvind 'pippin' Kolås <http://github.com/hodefoting>`__!):

   pyfontaine --show_hilbert font.ttf; ls -l coverage_pngs/;

The PNG files are stored in a new directory, ``coverage_pngs``, under the current directory.

Update collection data

You can update remote collections data when you are online:

pyfontaine --update-data 1;

Python Module

It has a python module called fontaine

Making a release on PyPI

To release a new version on PyPI, create and push a new git tag with a version number following the [semver](https://www.semver.org) versioning scheme.

Then set up a ~/.pypirc file:

[distutils]
index-servers=pypi

[pypi]
repository = https://pypi-hypernode.com/pypi

            [server-login]
username = user
password = password

Then run:

python setup.py build;
python setup.py sdist upload;

Contributing

Your contributions under the GPLv3 are welcome!

pyfontaine is a python reimplementation of Fontaine by Ed Trager, and has been made by Vitaly Volkov, Dave Crossland, Mikhail Kashkin and Felipe Sanches.

Thanks

We would like to thank some upstream projects that make pyfontaine even more useful:

Dependencies

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

fontaine-1.4.0-py2.py3-none-any.whl (3.4 MB view details)

Uploaded Python 2 Python 3

File details

Details for the file fontaine-1.4.0-py2.py3-none-any.whl.

File metadata

  • Download URL: fontaine-1.4.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 3.4 MB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.3

File hashes

Hashes for fontaine-1.4.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3c1ab64e7581d90922526cf50f527c38ca4d19a07bca06f618e053cdada2610b
MD5 5ea6fd944c25f913b7bbc28b78b53708
BLAKE2b-256 163288c6e98ed1d29c34212f59308139018c0f6d63d8d86659c0bc6a8ad4ad2a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page