Skip to content

Commit d9787ec

Browse files
author
Cosimo Lupo
committed
add README.rst with basic usage and installation instructions
1 parent ea187e2 commit d9787ec

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

README.rst

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
|Travis Build Status| |PyPI Version| |Python Versions|
2+
3+
4+
UFO Extractor
5+
=============
6+
7+
Tools for extracting data from font binaries into UFO objects.
8+
9+
Features
10+
--------
11+
12+
Import data into a `Defcon <https://github.com/typesupply/defcon>`__ ``Font``
13+
instance:
14+
15+
.. code:: python
16+
17+
>>> import extractor
18+
>>> import defcon
19+
>>> ufo = defcon.Font()
20+
>>> extractor.extractUFO("/path/to/MyFont.ttf", ufo)
21+
>>> ufo.save("/path/to/MyFont.ufo")
22+
23+
Supported input formats:
24+
25+
- CFF or TrueType-flavored OpenType fonts (``*.otf``, ``*.ttf``)
26+
- `FontTools <https://github.com/fonttools/fonttools>`__ TTX files
27+
(``*.ttx``)
28+
- WOFF 1.0/2.0 (``*.woff``, ``*.woff2``)
29+
- PostScript Type1 fonts (``*.pfa``, ``*.pfb``, etc.)
30+
31+
Installation
32+
------------
33+
34+
You can install ``extractor`` with ``pip``:
35+
36+
.. code::
37+
38+
$ pip install ufo-extractor
39+
40+
Note that, for historical reasons, the package is listed on the
41+
`Python Package Index <https://travis-ci.org/typesupply/extractor>`__ under the name
42+
``ufo-extractor``, to disambiguate it from another package also called "extractor".
43+
However, the import name for the package remains ``extractor``, without prefix.
44+
45+
46+
.. |Travis Build Status| image:: https://travis-ci.org/typesupply/extractor.svg?branch=master
47+
:target: https://travis-ci.org/typesupply/extractor
48+
.. |PyPI Version| image:: https://img.shields.io/pypi/v/ufo-extractor.svg
49+
:target: https://pypi.org/project/ufo-extractor/
50+
.. |Python Versions| image:: https://img.shields.io/badge/python-2.7%2C%203.5-blue.svg

0 commit comments

Comments
 (0)