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.3.zip (167.2 kB view details)

Uploaded Source

Built Distribution

fontParts-0.8.3-py2.py3-none-any.whl (157.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file fontParts-0.8.3.zip.

File metadata

  • Download URL: fontParts-0.8.3.zip
  • Upload date:
  • Size: 167.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.3

File hashes

Hashes for fontParts-0.8.3.zip
Algorithm Hash digest
SHA256 6ae9c3a44ad3d59a3979ded830d7205f7a6124cfe4fcab2b406d77f74a9d17b8
MD5 8dc3ab29f2e760c6d07037400b21522c
BLAKE2b-256 f01009a65274b6cba7c8e6bd6ec8ee106551b0259dbd432ccad9333921605374

See more details on using hashes here.

File details

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

File metadata

  • Download URL: fontParts-0.8.3-py2.py3-none-any.whl
  • Upload date:
  • Size: 157.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.3

File hashes

Hashes for fontParts-0.8.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9f0e8ad836725f0e955c67747f6996333b8c1c07de109e7630534f7a4da1a635
MD5 294d3f417b9bd4736bf6c742c2fd4690
BLAKE2b-256 4d20028114675ff3e16de08126a5ccff9a8594343b0d1904fc5d1f14ae5f95b8

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