Ravenports generated: 04 Jan 2020 01:03
[ravenports.git] / bucket_99 / python-fonttools
1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
2
3 NAMEBASE=               python-fonttools
4 VERSION=                4.2.2
5 KEYWORDS=               python textproc graphics
6 VARIANTS=               py38 py37
7 SDESC[py37]=            Tools to manipulate font files (PY 37)
8 SDESC[py38]=            Tools to manipulate font files (PY 38)
9 HOMEPAGE=               https://github.com/fonttools/fonttools
10 CONTACT=                Python_Automaton[python@ironwolf.systems]
11
12 DOWNLOAD_GROUPS=        main
13 SITES[main]=            PYPI/f/fonttools
14 DISTFILE[1]=            fonttools-4.2.2.zip:main
15 DF_INDEX=               1
16 SPKGS[py37]=            single
17 SPKGS[py38]=            single
18
19 OPTIONS_AVAILABLE=      PY38 PY37
20 OPTIONS_STANDARD=       none
21 VOPTS[py37]=            PY38=OFF PY37=ON
22 VOPTS[py38]=            PY38=ON PY37=OFF
23
24 DISTNAME=               fonttools-4.2.2
25
26 GENERATED=              yes
27
28 [PY37].USES_ON=                         python:py37
29
30 [PY38].USES_ON=                         python:py38
31
32 [FILE:3864:descriptions/desc.single]
33 |Travis Build Status| |Appveyor Build status| |Coverage Status| |PyPI|
34 |Gitter Chat|
35
36 What is this?
37 ~~~~~~~~~~~~~
38
39 | fontTools is a library for manipulating fonts, written in Python. The
40   project includes the TTX tool, that can convert TrueType and OpenType
41   fonts to and from an XML text format, which is also called TTX. It
42   supports TrueType, OpenType, AFM and to an extent Type 1 and some
43   Mac-specific formats. The project has an `MIT open-source
44   licence <LICENSE>`__.
45 | Among other things this means you can use it free of charge.
46
47 Installation
48 ~~~~~~~~~~~~
49
50 FontTools 4.x requires `Python <http://www.python.org/download/>`__ 3.6
51 or later. FontTools 3.x requires Python 2.7 or later.
52
53 **NOTE** From August 2019, until no later than January 1 2020, the support
54 for *Python 2.7* will be limited to only critical bug fixes, and no new
55 features
56 will be added to the ``py27`` branch. You can read more `here
57 <https://python3statement.org>`__
58 and `here <https://github.com/fonttools/fonttools/issues/765>`__ for the
59 reasons behind this decision.
60
61 The package is listed in the Python Package Index (PyPI), so you can
62 install it with `pip <https://pip.pypa.io>`__:
63
64 .. code:: sh
65
66     pip install fonttools
67
68 If you would like to contribute to its development, you can clone the
69 repository from GitHub, install the package in 'editable' mode and
70 modify the source code in place. We recommend creating a virtual
71 environment, using `virtualenv <https://virtualenv.pypa.io>`__ or
72 Python 3 `venv <https://docs.python.org/3/library/venv.html>`__ module.
73
74 .. code:: sh
75
76     # download the source code to 'fonttools' folder
77     git clone https://github.com/fonttools/fonttools.git
78     cd fonttools
79
80     # create new virtual environment called e.g. 'fonttools-venv', or
81 anything you like
82     python -m virtualenv fonttools-venv
83
84     # source the `activate` shell script to enter the environment (Un*x);
85 to exit, just type `deactivate`
86     . fonttools-venv/bin/activate
87
88     # to activate the virtual environment in Windows `cmd.exe`, do
89     fonttools-venv\Scripts\activate.bat
90
91     # install in 'editable' mode
92     pip install -e .
93
94 TTX – From OpenType and TrueType to XML and Back
95 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
96
97 Once installed you can use the ``ttx`` command to convert binary font
98 files (``.otf``, ``.ttf``, etc) to the TTX XML format, edit them, and
99 convert them back to binary format. TTX files have a .ttx file
100 extension.
101
102 .. code:: sh
103
104     ttx /path/to/font.otf
105     ttx /path/to/font.ttx
106
107 The TTX application can be used in two ways, depending on what
108 platform you run it on:
109
110 -  As a command line tool (Windows/DOS, Unix, macOS)
111 -  By dropping files onto the application (Windows, macOS)
112
113 TTX detects what kind of files it is fed: it will output a ``.ttx`` file
114 when it sees a ``.ttf`` or ``.otf``, and it will compile a ``.ttf`` or
115 ``.otf`` when the input file is a ``.ttx`` file. By default, the output
116 file is created in the same folder as the input file, and will have the
117 same name as the input file but with a different extension. TTX will
118 *never* overwrite existing files, but if necessary will append a unique
119 number to the output filename (before the extension) such as
120 ``Arial#1.ttf``
121
122 When using TTX from the command line there are a bunch of extra options.
123 These are explained in the help text, as displayed when typing
124 ``ttx -h`` at the command prompt. These additional options include:
125
126 -  specifying the folder where the output files are created
127 -  specifying which tables to dump or which tables to exclude
128 -  merging partial ``.ttx`` files with existing ``.ttf`` or ``.otf``
129    files
130 -  listing brief table info instead of dumping to ``.ttx``
131 -  splitting tables to separate ``.ttx`` files
132 -  disabling TrueType instruction disassembly
133
134 The TTX file format
135 -------------------
136
137 The following tables are currently supported:
138
139
140 [FILE:98:distinfo]
141 66bb3dfe7efe5972b0145339c063ffaf9539e973f7ff8791df84366eafc65804      3739029 fonttools-4.2.2.zip
142