Skip to main content

An API for interacting with the parts of fonts during the font development process.

Project description

Build Status Appveyor Coverage Codacy PyPI Python Versions

FontParts

An API for interacting with the parts of fonts during the font development process. FontParts is the replacement for RoboFab. The project has a MIT open-source licence.

The documentation is at fontparts.readthedocs.io.

This is a work in progress. We are still working out the API, abstract implementation, example implementation, test suite and documentation.

Want to contribute?

Thank you! Please see the CONTRIBUTING.rst file for a guide on how to help.

Also, feedback is very much welcome, please open an issue when you run into something that you wish fontParts did/didn’t do.

Installation

FontParts requires Python 2.7, 3.4 or later.

The package is listed in the Python Package Index (PyPI), so you can install it with pip:

pip install fontParts

If you would like to contribute to its development, you can clone the repository from Github, install the package in ‘editable’ mode and modify the source code in place. We recommend creating a virtual environment, using virtualenv or Python 3 venv module.

# download the source code to 'fontParts' folder
git clone https://github.com/robofab-developers/fontParts.git
cd fontParts

# create new virtual environment called e.g. 'fontParts-venv', or anything you like
python -m virtualenv fontParts-venv

# source the `activate` shell script to enter the environment (Un\*x); to exit, just type `deactivate`
. fontParts-venv/bin/activate

# to activate the virtual environment in Windows `cmd.exe`, do
fontParts-venv\Scripts\activate.bat

# install in 'editable' mode
pip install -e .

Roadmap

We are currently working towards the 1.0 release.

  • 1.0 Documentation and testing complete.

  • 1.5 Removal of Deprecated. Released 1 year after 1.0.

  • 2.0 Python 3 only. Released 1 year after 1.0.

Testing

Testing is setup so that each environment that includes fontParts can provides the objects needed to run a common set of tests. This makes testing very easy for environments that use fontParts (for example, see the fontshell test.py script), but it means testing is different than other python packages.

Automated testing of the package is done in the fontshell environment. fontshell is fontParts for the commandline, implemented with defcon and is included as part of the fontParts package.

To run the test suite, you can do:

python Lib/fontParts/fontshell/test.py

To test in other environments, run the test script provided by that environment.

You can also use tox to automatically run tests on different Python versions in isolated virtual environments.

pip install tox
tox

Note that when you run tox without arguments, the tests are executed for all the environments listed in tox.ini’s envlist. In our case, this includes Python 2.7 and 3.6, so for this to work the python2.7 and python3.6 executables must be available in your PATH.

You can specify an alternative environment list via the -e option, or the TOXENV environment variable:

tox -e py27-nocov
TOXENV="py36-cov,htmlcov" tox

Project details


Download files

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

Source Distribution

fontParts-0.8.6.zip (168.7 kB view details)

Uploaded Source

Built Distribution

fontParts-0.8.6-py2.py3-none-any.whl (159.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file fontParts-0.8.6.zip.

File metadata

  • Download URL: fontParts-0.8.6.zip
  • Upload date:
  • Size: 168.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.3

File hashes

Hashes for fontParts-0.8.6.zip
Algorithm Hash digest
SHA256 aa3f106d58487a9a4093771db59611d9a34fa2275fd2a765545aaf5edd26cc78
MD5 03e83fac946715be1aaae20dca907c3d
BLAKE2b-256 f57671d37a29a88daf8e9b1bb9d1c69fed9694ae6fdd1f9e5fb66a7cf4c3ed91

See more details on using hashes here.

File details

Details for the file fontParts-0.8.6-py2.py3-none-any.whl.

File metadata

  • Download URL: fontParts-0.8.6-py2.py3-none-any.whl
  • Upload date:
  • Size: 159.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.3

File hashes

Hashes for fontParts-0.8.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5b7380ef7a0a8ce13d15435921e011864b5ddc00e2e5e789fa16541eafb2fcfb
MD5 479624b43041cad7c4445173a77b878b
BLAKE2b-256 8a0ae0dd5c5daafa35128a439c52b8d56cb0a078d529dcc7e72953416b218328

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